Get all banks by country
GETTag: api-payments-gateway-get-bank-all-by-countryDescription: Retrieve all banks for the authenticated user by country./v1/payout/banks/:country
Request
Path Parameters
Possible values: [BRA, ARG, CHL, PER]
Country code to filter banks.
Query Parameters
Default value: 1
Page number.
Possible values: <= 100
Default value: 20
Page size. Max size is 100.
Possible values: [created_at]
Page sort attribute.
Possible values: [asc, desc]
Default value: asc
Page order.
Header Parameters
Sender Wallet UUID (if empty, your default Wallet UUID will be settled)
The nonce ID is a UUID (v4) used to uniquely identify the request. All requests must have an identifier.
Possible values: [pt-BR, en-US]
Indicates the preferred language. Defaults to Brazilian Portuguese if unspecified.
The product ID is a UUID (v4) used to identify the Z.ro product configuration.
The product target user ID is a UUID (v4) used to identify what user account this request must be executed. Require: x-product-uuid.
Responses
- 200
- 400
- 401
- 422
Banks retrieved successfully.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
Page number.
Page size.
Page total.
Total of elements.
data object[]required
Banks data.
Bank ID.
Country of the bank.
Bank type.
Bank code.
Bank name.
Full name of the bank.
Indicates if the bank is active.
Creation date of the deposit record.
Last update date of the deposit record.
{
"page": 1,
"page_size": 20,
"page_total": 20,
"total": 100,
"data": [
{
"id": "0197b169-da6b-7ba2-b053-ce413ae39afd",
"country": "ARG",
"type": "commercial",
"code": "001",
"name": "Bank of Example",
"full_name": "The Bank of Example Corporation",
"active": true,
"created_at": "2023-09-30T12:00:00Z",
"updated_at": "2023-10-01T15:00:00Z"
}
]
}
If any required params are missing or has invalid format or type.
User authentication failed.
If any required params are missing or has invalid format or type.