Bancos

La API de Bancos proporciona dos endpoints para consultar información bancaria: una búsqueda directa por código de banco y un listado paginado por país. Úselos para poblar menús desplegables de selección de bancos y validar códigos bancarios antes de enviar pagos.

Buscar un Banco

Recupere los detalles de un banco específico por su código y país.

Endpoint

GET https://{FQDN}/bank

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Parámetros de Consulta

Parámetro	Tipo	Requerido	Descripción
`bankNumber`	string	Sí	Código de la institución bancaria (p. ej., `"341"`, `"7339"`)
`countryCode`	string	Sí	Código de país (p. ej., `"BR"`, `"SG"`)

Ejemplo de Solicitud

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

Respuesta (200)

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

Listar Bancos por País

Recupere una lista paginada de todos los bancos disponibles en un país determinado.

Endpoint

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

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Parámetros de Consulta

Parámetro	Tipo	Requerido	Descripción
`countryCode`	string	Sí	Código de país (p. ej., `"BR"`, `"US"`, `"SG"`)
`page`	integer	No	Número de página (comienza en cero)
`resultsPerPage`	integer	No	Número de resultados por página

Ejemplo de Solicitud

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

Respuesta (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
}

Qué Sigue

Schemas — Obtenga los requisitos de campos específicos por país para cuentas, payouts y personas
Transacción Push — Envíe payouts a cuentas bancarias, tarjetas, PIX y billeteras
Directorio de Alias — Resuelva alias de pago instantáneo antes de enviar payouts