Bancos

A API de Bancos fornece dois endpoints para consultar informações bancárias: uma consulta direta por código do banco e uma listagem paginada por país. Use-os para preencher listas de seleção de bancos e validar códigos bancários antes de enviar pagamentos.

Consultar um Banco

Recupere os detalhes de um banco específico pelo seu código e país.

Endpoint

GET https://{FQDN}/bank

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`bankNumber`	string	Sim	Código da instituição bancária (ex.: `"341"`, `"7339"`)
`countryCode`	string	Sim	Código do país (ex.: `"BR"`, `"SG"`)

Exemplo de Requisição

curl -X GET 'https://{FQDN}/bank?bankNumber=341&countryCode=BR' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Resposta (200)

{
  "bankCode": "341",
  "bankName": "Itaú Unibanco",
  "countryCode": "BR",
  "swift": "ITAUBRSP"
}

Listar Bancos por País

Recupere uma lista paginada de todos os bancos disponíveis em um determinado país.

Endpoint

GET https://{FQDN}/bank/list

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Parâmetros de Consulta

Parâmetro	Tipo	Obrigatório	Descrição
`countryCode`	string	Sim	Código do país (ex.: `"BR"`, `"US"`, `"SG"`)
`page`	integer	Não	Número da página (começando em zero)
`resultsPerPage`	integer	Não	Número de resultados por página

Exemplo de Requisição

curl -X GET 'https://{FQDN}/bank/list?countryCode=BR&page=0&resultsPerPage=5' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Resposta (200)

{
  "banks": [
    {
      "bankCode": "001",
      "bankName": "Banco do Brasil",
      "countryCode": "BR",
      "swift": "BRASBRRJ"
    },
    {
      "bankCode": "033",
      "bankName": "Banco Santander",
      "countryCode": "BR",
      "swift": "BSCHBRSP"
    },
    {
      "bankCode": "104",
      "bankName": "Caixa Econômica Federal",
      "countryCode": "BR",
      "swift": "CABORJBR"
    },
    {
      "bankCode": "237",
      "bankName": "Banco Bradesco",
      "countryCode": "BR",
      "swift": "BBDEBRSP"
    },
    {
      "bankCode": "341",
      "bankName": "Itaú Unibanco",
      "countryCode": "BR",
      "swift": "ITAUBRSP"
    }
  ],
  "page": 0,
  "resultsPerPage": 5,
  "totalResults": 42
}

Próximos Passos

Schemas — Obtenha os requisitos de campos específicos de cada país para contas, payouts e pessoas
Push Transaction — Envie payouts para contas bancárias, cartões, PIX e carteiras
Alias Directory — Resolva aliases de pagamento instantâneo antes de enviar payouts