PaaS API Docs
Search…
⌃K

Get Banks

Read on populating banks available for payout
The bank and branch APIs provide the list of banks and their respective branches that are available in the destination country.

Get bank list

GET /banks?country={{country}}

Query Parameter
Request Sample
Response Sample
Name
Type
Required
Description
country
String
No
curl --location --request GET '{{url}}/banks' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
"branches": [
{
"id": 169,
"name": "Default Branch"
}
],
"country": "CO",
"id": 126,
"name": "Banco Santander De Negocios",
"txn_supported_types": [
"C2C",
"B2B",
"B2C"
]
},
{
"branches": [
{
"id": 101,
"name": "Default Branch"
}
],
"country": "MX",
"id": 58,
"name": "All Banks / Payment Type: Clabe",
"txn_supported_types": [
"C2C"
]
}

Get bank by ID

GET /banks/{{bankId}}

Request Sample
Response Sample
curl --location --request GET '{{url}}/banks/{bank_id}' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
"branches": [
{
"id": 169,
"name": "Default Branch"
}
],
"country": "CO",
"id": 126,
"name": "Banco Santander De Negocios",
"receiving_currency": [
"COP"
],
"txn_supported_types": [
"C2C",
"B2B",
"B2C"
]
}