BAbankly
Instituições Financeiras

Listagem de instituições financeiras

<div class="bkly-ref-description"> <p>Obtenha 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 outras.</p> <span class="bkly-ref-small-stable-tag">stable</span> <span class="bkly-ref-scope-tag">scope: banklist.read</span> </div> [block:callout] { "type": "info", "title": "Nota", "body": "Caso não seja enviado um valor no campo <code>product</code>, será assumido o valor padrão <b>TED</b>. Confira a documentação [Listagem de instituições financeiras](/docs/listagem-bancos) para mais informações." } [/block]
get/banklist

Request

  • Base URL
    https://api-mtls.sandbox.bankly.com.br
  • URL
    https://api-mtls.sandbox.bankly.com.br/banklist
  • Auth
    HTTP bearer

Query parameters

namestring nullable

Nome do banco que deseja consultar.

product'TED' | 'PIX' | 'accountPortability'

Nome do produto.

idstring[] nullable

Código do banco. Este campo aceita mais de um valor, o qual resulta em múltiplas consultas. Ex.: id=332&id=223.

pagestring nullable

Página que deseja consultar.

pageSizestring

Quantidade de bancos a serem exibidos por página.

Headers

api-versionstring required

Versão da API. Atualmente estamos na 1.0.

Authorizationstring required

<i>Token</i> de autorização do tipo Bearer.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.