Listar Bancos (Open Finance)

Lista os bancos disponíveis para pagamentos via Open Finance na sua conta.

Retorna os bancos habilitados para Open Finance na sua conta, de acordo com a configuração do seu parceiro bancário. Use o campo id de cada banco como bankId ao criar um Payin com paymentMethod: OPEN_FINANCE.

GET https://api.legacyecombr.com.br/payin/open-finance/banks
📘

Autenticação obrigatória

Envie o cabeçalho Authorization: Basic base64(pk_live_xxxx:sk_live_yyyy) — a mesma credencial usada em Criar Payin. A lista é resolvida a partir da configuração da sua conta.


Resposta

{
  "banks": [
    { "id": "nubank", "name": "Nubank", "logo": "https://logo.clearbit.com/nubank.com.br" },
    { "id": "itau", "name": "Itaú Unibanco", "logo": "https://logo.clearbit.com/itau.com.br" },
    { "id": "bb", "name": "Banco do Brasil", "logo": "https://logo.clearbit.com/bb.com.br" }
  ]
}
CampoTipoDescrição
banksarrayLista de bancos habilitados. Vazia quando o Open Finance não está configurado na conta
banks[].idstringIdentificador do banco — use como bankId ao criar o Payin
banks[].namestringNome de exibição do banco
banks[].logostring (URL)URL do logotipo (quando disponível)
👍

Como usar

  1. Liste os bancos com este endpoint.
  2. Apresente as opções ao cliente.
  3. Crie o Payin enviando o id escolhido em bankId. Veja o guia de Open Finance.

Did this page help you?