Retrieve

The retrieve route is responsible for retrieving information from an existing payment account.

🚧

Attention point:

To consume the route it is necessary to pass the account code as a parameter.

Response

Http CodeReturn CodeMessage
200200-01Success.
400400-01Something unexpected happened.
400400-02Invalid hash.
400400-09There are no results for the query.
401401-05Unauthorized or token invalid
429429-01Too many requests

Response Parameters

ParameterFormatDescription
request_codestringCode of the request made
returnbooleanIndicates if the request was successful
return_codestringReturn code of the request
messagestringMessage indicating the reason for the response
dataarrayArray containing information of the account
data.codestringAccount code
data.document_customerstringCustomer document
data.bank_codestringBank code
data.bank_namestringBank name
data.account_numberstringAccount number
data.code_accountstringAccount code
data.agency_numberstringAgency number
data.code_agencystringAgency code
data.code_operationstringOperation code
data.type_accountstringAccount type
data.created_atstringAccount creation date and time

Request Parameters

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here!