Aparência
Banking — Pix e boletos
O prefixo /banking reúne as rotas que executam operações diretamente no banco da conta: no Pix, chaves, QR Code estático, pagamento de copia e cola e transferências; no boleto, o pagamento de boletos de terceiros (Pagamento de boletos).
Todas as rotas exigem autenticação e conta ativa:
Authorization: Bearer {token}
Content-Type: application/json
account: {account_id}O usuário precisa ter acesso à conta informada em account. Se não tiver, a resposta é 403.
As rotas que movem dinheiro (Pix transfers/key, transfers/bank-account e transfers/copy-paste, TED em /banking/transfers e boleto/payments/pay) exigem o header Idempotency-Key. Ver Idempotência.
Os bancos com cada recurso são: chaves e verificação na Fidúcia e no Teste; copia e cola só no Teste; envio e cobranças conforme o driver do banco da conta; pagamento de boleto só no Teste (Fidúcia ainda não implementa).
Rotas
| Método | Rota | O que faz |
|---|---|---|
GET | /banking/pix/keys | Lista as chaves Pix da conta (Chaves Pix) |
POST | /banking/pix/keys | Inclui uma chave |
GET | /banking/pix/keys/{chave} | Consulta uma chave |
DELETE | /banking/pix/keys/{chave} | Remove uma chave |
GET | /banking/pix/keys/verify?key={chave} | Verifica a quem pertence uma chave (própria ou de terceiro) |
GET | /banking/pix/static-qrcode | Copia e cola estático da conta, sem valor (QR Code estático) |
POST | /banking/pix/qrcode/dynamic | Copia e cola dinâmico, com valor, sem criar cobrança (QR Code dinâmico) |
POST | /banking/pix/transfers/copy-paste/decode | Prévia de um copia e cola (Pix copia e cola) |
POST | /banking/pix/transfers/copy-paste | Paga um copia e cola |
GET | /banking/pix/transfers | Lista as transferências Pix enviadas (Transferências Pix) |
POST | /banking/pix/transfers/lookup | Consulta a chave de destino e abre a transferência |
POST | /banking/pix/transfers/key | Confirma a transferência por chave (PIN) |
POST | /banking/pix/transfers/bank-account | Transferência por dados bancários (PIN) |
POST | /banking/boleto/payments/decode | Consulta um boleto de terceiro para pagar (Pagamento de boletos) |
POST | /banking/boleto/payments/pay | Paga o boleto consultado (PIN) |
GET | /banking/boleto/payments | Lista os pagamentos de boleto |
GET | /banking/boleto/payments/{id} | Detalhe de um pagamento de boleto |
GET | /banking/pix/transfers/{id} | Detalhe de uma transferência |
GET | /banking/pix/recipients | Destinatários já usados (paginado) |
GET | /banking/pix/recipients/frequent | Destinatários frequentes |
GET | /banking/pix/recipients/frequent/{id} | Um destinatário frequente |
Para testar sem dinheiro real, use uma conta na homologação da Fidúcia (sandbox).
Formato das respostas
As rotas vieram de controllers diferentes e não compartilham um único envelope. Cada página traz o exemplo real de cada rota:
| Formato | Rotas |
|---|---|
{ "code", "success", "message", "data" } | transfers/key, recipients/frequent*, transfers/copy-paste*, keys (listar, consultar, verificar, excluir), static-qrcode |
{ "data", "message" } | POST keys |
{ "data" } | POST transfers/lookup (consulta da chave) |
{ "data", "transaction" } | transfers/bank-account, transfers/{id} |
{ "data", "meta" } | GET transfers |
Paginação padrão do Laravel (current_page, data, total...) | recipients |
Migração das rotas antigas (breaking change)
As rotas antigas foram removidas e passam a responder 404. Quem integra por token de API precisa trocar os caminhos. Corpo e resposta de cada rota não mudaram, só o caminho.
| Rota antiga | Rota nova |
|---|---|
GET /pix-keys | GET /banking/pix/keys |
POST /pix-keys | POST /banking/pix/keys |
GET /pix-keys/{chave} | GET /banking/pix/keys/{chave} |
DELETE /pix-keys/{chave} | DELETE /banking/pix/keys/{chave} |
GET /quickpay/pix/list | GET /billing/charges?payment_method=PIX |
POST /quickpay/pix/create | POST /billing/charges (payment_method: PIX) |
POST /quickpay/pix/qrcode | POST /billing/charges (payment_method: PIX) |
POST /quickpay/pix/qrcode-fixo | POST /billing/charges (payment_method: PIX) |
GET /quickpay/pix/{txid} | GET /billing/charges/{id} |
GET /quickpay/pix/image | GET /banking/pix/static-qrcode |
POST /pix/qrcode/decode | POST /banking/pix/transfers/copy-paste/decode |
POST /pix/qrcode/pay | POST /banking/pix/transfers/copy-paste |
GET /quickpay/withdraws | GET /banking/pix/transfers |
POST /quickpay/withdraws | POST /banking/pix/transfers/lookup |
POST /quickpay/withdraws/confirm | POST /banking/pix/transfers/key |
POST /quickpay/withdraws/bank | POST /banking/pix/transfers/bank-account |
GET /quickpay/withdraws/{id} | GET /banking/pix/transfers/{id} |
GET /quickpay/withdraws/recipients | GET /banking/pix/recipients |
GET /quickpay/withdraws/recipients/frequent | GET /banking/pix/recipients/frequent |
GET /quickpay/withdraws/recipients/frequent/{id} | GET /banking/pix/recipients/frequent/{id} |
Removidas sem substituto (rotas legadas da Sicredi, sem uso no portal): POST /quickpay/saida-sicred, POST /quickpay/pix-out/dataBank, POST /quickpay/boleto-saida-sicred, POST /quickpay/pix/lookup, POST /quickpay/pixout/pix-key, POST /quickpay/pixout/pix-databank.
O pagamento de boletos de terceiros continuou em /quickpay até 03/10/2026. Os links de pagamento foram removidos em 14/10/2026.
Atualização (2 de outubro de 2026): as cobranças Pix (/banking/pix/charges) e os boletos (/quickpay/boleto(s)) também foram removidos. A emissão passou para /billing/charges. Veja Cobranças Pix e boleto.
Atualização (3 de outubro de 2026): o pagamento de boletos de terceiros saiu de /quickpay/boleto/* e foi para /banking/boleto/payments. As rotas antigas respondem 404. Veja Pagamento de boletos.