Sign in

v1

latestOpenAPI 3.1.02026-07-2440101174.2 KB
Instituições Financeiras

Consulta de instituições financeiras por ISPB ou código bancário

Consulte informações sobre a instituição financeira através do ISPB ou código bancário.

get/banklist/{id}

Path parameters

idstring nullable required

Id corresponde ao ISPB ou Code. <b>Importante</b>: o campo deve conter oito caracteres. Portanto, se o ISPB do banco contiver apenas seis dígitos, por exemplo, complete-o com zeros à esquerda. Exemplo: "00123456".

Example:332

Id corresponde ao ISPB ou Code. <b>Importante</b>: o campo deve conter oito caracteres. Portanto, se o ISPB do banco contiver apenas seis dígitos, por exemplo, complete-o com zeros à esquerda. Exemplo: "00123456".

Headers

api-versionstring required

Versão da API. Atualmente estamos na 1.0.

Response

Recurso encontrado

namestring nullable

Nome do banco.

ispbstring

ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco.

codestring nullable

Código do banco. Este campo somente é retornado caso a instituição seja participante do SPB (possui TED). As instituições que participam somente do SPI (que só possuem Pix) não retornarão o campo <code>code</code> nessa pesquisa.

shortNamestring nullable

Nome reduzido do banco.

isSPIDirectboolean nullable

Indica se o banco é um participante direto do SPI (Pix).

productsstring[] nullable

Lista que contém os produtos suportados pelo registro da instituição financeira (TED, PIX e/ou accountPortability).

accountPortabilityTypesstring[]

Lista que contém as funções do banco, referentes à portabilidade de salário ("Payroll" e/ou "Destination"). Este campo somente é retornado caso o banco possua portabilidade de salário (accountPortability) como produto.