Banks in a country

For some country destinations we have a list of the available banks.

Parameter	Type	Required	Description
tenant	string	Yes	The tenant identifier for your organization.
destinationCountryIso2	string	Yes	ISO 3166-1 alpha-2 code of the destination country (e.g., US, BR, MX).

Sample Request

curl --request GET \
  --url {api_endpoint}/organizations/{tenant}/payout/{destinationCountryIso2}/banks \
  --header 'content-type: application/json' \
  --header 'x-agent-api-key: {agentApiKey}' \
  --header 'x-agent-id: {agentId}'

[
  {
    "code": "007",
    "name": "BANCO BCSC"
  },
  {
    "code": "1000",
    "name": "BANCO REPÚBLICA"
  },
  {
    "code": "1001",
    "name": "BANCO DE BOGOTÁ"
  }
]

The response is a plain array of active banks. Use the optional size query parameter to limit results (default 100). The code value is what you pass as payoutMethod.bankCode when creating a recipient account.

Documentation

GET /organizations/{tenant}/payout/{destinationCountryIso2}/banks