Bancos em um país

Para alguns países de destino, temos uma lista dos bancos disponíveis.

Parâmetro	Tipo	Obrigatório	Descrição
tenant	string	Sim	O identificador do tenant da sua organização.
destinationCountryIso2	string	Sim	Código ISO 3166-1 alpha-2 do país de destino (ex.: US, BR, MX).

Exemplo de Requisição

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Á"
  }
]

A resposta é um array simples de bancos ativos. Use o parâmetro de query opcional size para limitar os resultados (padrão 100). O valor de code é o que você passa como payoutMethod.bankCode ao criar uma conta de destinatário.

Documentação

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