Skip to content

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étodoRotaO que faz
GET/banking/pix/keysLista as chaves Pix da conta (Chaves Pix)
POST/banking/pix/keysInclui 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-qrcodeCopia e cola estático da conta, sem valor (QR Code estático)
POST/banking/pix/qrcode/dynamicCopia e cola dinâmico, com valor, sem criar cobrança (QR Code dinâmico)
POST/banking/pix/transfers/copy-paste/decodePrévia de um copia e cola (Pix copia e cola)
POST/banking/pix/transfers/copy-pastePaga um copia e cola
GET/banking/pix/transfersLista as transferências Pix enviadas (Transferências Pix)
POST/banking/pix/transfers/lookupConsulta a chave de destino e abre a transferência
POST/banking/pix/transfers/keyConfirma a transferência por chave (PIN)
POST/banking/pix/transfers/bank-accountTransferência por dados bancários (PIN)
POST/banking/boleto/payments/decodeConsulta um boleto de terceiro para pagar (Pagamento de boletos)
POST/banking/boleto/payments/payPaga o boleto consultado (PIN)
GET/banking/boleto/paymentsLista 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/recipientsDestinatários já usados (paginado)
GET/banking/pix/recipients/frequentDestinatá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:

FormatoRotas
{ "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 antigaRota nova
GET /pix-keysGET /banking/pix/keys
POST /pix-keysPOST /banking/pix/keys
GET /pix-keys/{chave}GET /banking/pix/keys/{chave}
DELETE /pix-keys/{chave}DELETE /banking/pix/keys/{chave}
GET /quickpay/pix/listGET /billing/charges?payment_method=PIX
POST /quickpay/pix/createPOST /billing/charges (payment_method: PIX)
POST /quickpay/pix/qrcodePOST /billing/charges (payment_method: PIX)
POST /quickpay/pix/qrcode-fixoPOST /billing/charges (payment_method: PIX)
GET /quickpay/pix/{txid}GET /billing/charges/{id}
GET /quickpay/pix/imageGET /banking/pix/static-qrcode
POST /pix/qrcode/decodePOST /banking/pix/transfers/copy-paste/decode
POST /pix/qrcode/payPOST /banking/pix/transfers/copy-paste
GET /quickpay/withdrawsGET /banking/pix/transfers
POST /quickpay/withdrawsPOST /banking/pix/transfers/lookup
POST /quickpay/withdraws/confirmPOST /banking/pix/transfers/key
POST /quickpay/withdraws/bankPOST /banking/pix/transfers/bank-account
GET /quickpay/withdraws/{id}GET /banking/pix/transfers/{id}
GET /quickpay/withdraws/recipientsGET /banking/pix/recipients
GET /quickpay/withdraws/recipients/frequentGET /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.