O que é
O ledger (livro-caixa) registra linhas de crédito e débito associadas a operações Pix confirmadas (conforme o pipeline e regras de domínio), para auditoria e conciliação com o parceiro. O saldo da organização é mantido de forma consistente com reservas de cash-out e consumo/liberação pós-webhook, conforme a arquitetura documentada.Consulta
GET /api/pix/ledger— listagem, preferencialmente com cursor; filtros:operation(credit/debit),entry_type(ex.:pix_cash_in_credit,pix_cash_out_debit),start_date/end_dateinclusivos,limit(máx. 100 comum no texto de origem).GET /api/pix/ledger/{id}— detalhe de uma linha por UUID.
TODO: schema JSON de resposta; formato exato de cursor — a origem não fornece exemplos de payload.
Contextos (exemplos, origem)
| Contexto | Lançamento |
|---|---|
Cash-in PAID | Crédito |
Refund-in CONFIRMED | Débito (devolução ao pagador) |
Cash-out CONFIRMED | Débito (envio) |
| Reversão de cash-out | Crédito (estorno do envio) |
Relação com o restante do fluxo
Operações aindaPENDING ou em estado ambíguo não têm o mesmo significado de “fechado no ledger” que pós-PAID / CONFIRMED (conforme regras de cada produto). Integre com o status e a reconciliação.