Listagem de instituições financeiras
stable
Este endpoint retorna uma lista de instituições financeiras e suas informações, como o ISPB, os produtos ofertados, o tipo de banco (se é folha, destino ou ambos), dentre outros.
Além disso, é possível filtrar a pesquisa pelo nome do banco (name), por um produto específico (product), pelo seu código (id) e configurar a exibição dos resultados, com os campos page e pageSize.
Nota
A lista de instituições financeiras é atualizada apenas uma vez ao dia, às 10 horas da manhã.
Requisição (Request)
Requisição HTTP
GET https://api-mtls.sandbox.bankly.com.br/banklist
--request GET \
--url 'https://api-mtls.sandbox.bankly.com.br/banklist' \
--header 'accept: application/json' \
--header 'api-version: 1'
--header 'authorization: Bearer {token}'
Autorização
Para garantir a segurança nas requisições, todos os endpoints do Bankly utilizam scopes como parte do seu fluxo de autorização.
Esta requisição requer o scope descrito a seguir:
| Scope | Descrição |
|---|---|
banklist.read | Concede acesso para consultar a lista de instituições financeiras. |
Cabeçalhos (Headers)
| Nome | Descrição |
|---|---|
api-version | Obrigatório. Versão da API. Atualmente estamos na versão 1.0. |
Authorization | Obrigatório. Token de autorização do tipo Bearer. |
Parâmetros da rota (Path)
No path desta requisição envie os seguintes campos:
| Nome | Tipo | Descrição |
|---|---|---|
name | query | Nome do banco que deseja consultar. |
product | query | Nome do produto, o qual pode ser “TED”, “PIX” ou “accountPortability” (portabilidade de salário). Caso este campo não seja preenchido, o valor padrão é “TED”. |
id | query | Código do banco. Este campo aceita mais de um valor, o qual resulta em múltiplas consultas. Ex.: id=4&id=8. |
page | query | Página que deseja consultar. Caso este campo seja preenchido, o campo pageSize terá como valor padrão 20. |
pageSize | query | Quantidade de bancos a serem exibidos por página. |
Dica
Recomendamos que o
pageSizeseja preenchido para uma melhor experiência do usuário.
Corpo da requisição (Body)
Não é necessário enviar campos no body desta requisição.
Resposta (Response)
O status code 200 indicará que a solicitação foi aceita com sucesso e uma lista de objetos com os bancos e sua informações será retornada.
Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:
| Nome | Tipo | Descrição |
|---|---|---|
name | string | Nome do banco. |
ispb | string | ISPB (Identificador de Sistema de Pagamentos Brasileiro) do banco. |
code | string | 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 nessa pesquisa. |
shortName | string | Nome reduzido do banco. |
isSPIDirect | boolean | Indica se o banco é um participante direto do SPI (Pix). |
products | array of strings | Lista que contém os produtos suportados pelo registro da instituição financeira. As opções são: "TED", "PIX" e "accountPortability" (portabilidade de salário). |
accountPortabilityTypes | array of strings | Lista que contém as funções do banco, referente à portabilidade de salário. As opções são: “Payroll” (banco folha) e “Destination” (banco destino). Este campo somente é retornado caso o banco possua portabilidade de salário (accountPortability) como produto. |
[
{
"name": "Acesso Soluções De Pagamento S.A.",
"ispb": "13140088",
"code": "332",
"shortName": "Acesso Solucoes Pagamento Sa",
"isSPIDirect": true,
"products": [
"TED",
"PIX",
"accountPortability"
],
"accountPortabilityTypes": [
"Payroll",
"Destination"
]
},
{
"name": "Banco Do Brasil S.A.",
"ispb": "00000000",
"code": "001",
"shortName": "Bco Do Brasil S.A.",
"isSPIDirect": true,
"products": [
"TED",
"PIX",
"accountPortability"
],
"accountPortabilityTypes": [
"Payroll",
"Destination"
]
}
]
Atualmente, a Acesso/Bankly atua apenas como banco destino. Dessa forma, o valor "Payroll" retornado no campo accountPortabilityTypes deve ser desconsiderado nesse caso.
Dica
Para simular uma requisição nesse endpoint, acesse o API Reference.
Erros
Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.
Eventos
Este endpoint não possui eventos relacionados a ele.
Importante
O tempo máximo de resposta de nossas APIs é de 30 segundos.
Updated 6 months ago