Dados bancários
Como ler agência, conta e chave PIX dos fornecedores, e o registro que cada leitura deixa.
Em resumo
- Dado bancário exige a permissão
contabancaria.ler, concedida à parte na integração. - Sai só por fornecedor ou por conta, nunca numa listagem geral.
- Cada conta lida fica registrada no Afflux, com o
requestId, na mesma operação da leitura. - A conta de destino de uma conta a pagar está em
contaBancariaId.
Os endpoints
| Endpoint | Devolve |
|---|---|
GET /fornecedores/{id}/contas-bancarias | As contas vigentes do fornecedor, a principal primeiro |
GET /contas-bancarias/{id} | Uma conta pelo id, mesmo fora de vigência |
{
"id": "bb2b9885-…",
"fornecedorId": "63fc5e1d-…",
"apelido": "Conta principal",
"banco": "341",
"agencia": "1234",
"conta": "56789-0",
"tipoConta": "corrente",
"chavePix": null,
"titular": { "nome": "Prestadora Exemplo Ltda.", "documento": "12345678000199" },
"principal": true,
"vigenteDe": "2026-03-01T12:00:00+00:00",
"vigenteAte": null,
"vigente": true
}Qual conta usar para pagar
A conta a pagar aponta a conta de destino em contaBancariaId — a principal vigente no momento da aprovação. Se o fornecedor trocou de conta depois, a antiga aparece com vigente: false; ainda assim é ela o destino daquela dívida, a menos que a empresa combine outra coisa. Para pagamentos novos, use as contas vigentes de /fornecedores/{id}/contas-bancarias.
O registro de cada leitura
Cada conta devolvida grava, na mesma operação, quem leu (a integração), qual conta, de qual fornecedor e quando. Quem administra as integrações vê esse registro na tela da integração. Se o registro não puder ser gravado, o dado não sai.
Privacidade (LGPD)
Os dados bancários e os CPFs de prestadores pessoa física são dados pessoais. Ao conceder esta permissão, a sua empresa passa a tratar esses dados também no sistema que os recebe: guarde-os com o mesmo cuidado, só pelo tempo necessário, e restrinja quem os vê.
Indisponível
Se um dado bancário não puder ser lido com segurança, a API responde 503 com o código indisponivel — nunca uma conta pela metade. Tente de novo mais tarde e, se persistir, informe o requestId ao suporte.