Listagem de Instituições

É possível filtrar a pesquisa por um produto específico (product)

📘
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://stageapi.meuacessobackoffice.com.br/ted/listBanking

--request GET 'https://stageapi.meuacessobackoffice.com.br/ted/listBanking' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
version	cutting-edge	Essa propriedade garante que o response da API seja retornado no formato JSON
Authorization	Bearer token	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path)

Nome	Tipo	Descrição
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”.

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.

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 este campo.
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).

[
  {
    "name": "Acesso Soluções De Pagamento S.A.",
    "ispb": "13140088",
    "code": "332",
    "shortName": "Acesso Solucoes Pagamento Sa",
    "isSPIDirect": true,
    "products": [
      "TED",
      "PIX",
     "accountPortability"
    ]
  },
  {
    "name": "Banco Do Brasil S.A.",
    "ispb": "00000000",
    "code": "001",
    "shortName": "Bco Do Brasil S.A.",
    "isSPIDirect": true,
    "products": [
      "TED",
      "PIX",
      "accountPortability"
    ]
  }
]

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.