8.5. Eventos de Parcela¶
Especificação — em construção
Os serviços descritos nesta área ainda não estão disponíveis.
Eventos da vida do contrato depois de formalizado: cobrança emitida, parcela baixada e contrato liquidado.
O envelope, os headers, a assinatura HMAC e a política de retry estão em 8.1. Visão Geral.
credito.parcela.cobranca_registrada¶
Disparado quando uma cobrança é emitida com sucesso para a parcela — seja por 7.4. Cobrança, seja pela geração automática da plataforma em esteiras com cobrança interna.
{
"idWebhook": "019e089c-2363-70ab-169d-e2677380ac4f",
"tipoEvento": "credito.parcela.cobranca_registrada",
"dataHora": "2026-09-28T08:12:33.104Z",
"grupoEconomico": "MeuGrupo",
"dados": {
"idContrato": 5001,
"idParcela": 8801,
"numero": 1,
"produto": "ep",
"numeroCcb": "PROP-2026-004821",
"valor": 850.00,
"dataVencimento": "2026-10-13",
"linhaDigitavel": "34191.79001 01043.510047 91020.150008 1 99860000085000",
"numCodBarras": "34191998600000850001790001010435100479102015000",
"pixCopiaECola": null,
"codigoLiquidacao": "9e4f2a1c-6b3d-4e7a-8c1f-3a2d9e5b7c04"
},
"etiquetas": null
}
🧾 Detalhamento dos Campos — dados¶
| Campo | Tipo | Descrição |
|---|---|---|
| idContrato / idParcela | integer | Identificadores da parcela cobrada |
| numero | integer | Número da parcela no fluxo |
| valor | number | Valor da cobrança |
| dataVencimento | string | Vencimento da cobrança |
| linhaDigitavel / numCodBarras | string / null | Dados do boleto, quando emitido |
| pixCopiaECola | string / null | Código PIX, quando emitido |
| codigoLiquidacao | string | Identificador da cobrança, usado para cancelá-la |
🧭 O que fazer ao receber¶
Entregue a cobrança ao cliente. Se você precisa do PDF, use 7.5. Boleto e Carnê.
credito.parcela.liquidada¶
Disparado quando uma parcela é baixada — por 7.3. Liquidar Parcela ou pelo pagamento de uma cobrança emitida pela plataforma.
{
"idWebhook": "019e089d-4574-71bc-27ae-f3788491bd50",
"tipoEvento": "credito.parcela.liquidada",
"dataHora": "2026-10-13T18:45:09.882Z",
"grupoEconomico": "MeuGrupo",
"dados": {
"idContrato": 5001,
"idParcela": 8801,
"numero": 1,
"produto": "ep",
"numeroCcb": "PROP-2026-004821",
"dataPagamento": "2026-10-13",
"valorPagamento": 850.00,
"valorMulta": 0.00,
"valorMora": 0.00,
"valorDesconto": 0.00,
"origem": "api",
"parcelasEmAberto": 23
},
"etiquetas": null
}
🧾 Detalhamento dos Campos — dados¶
| Campo | Tipo | Descrição |
|---|---|---|
| dataPagamento | string | Data do pagamento |
| valorPagamento | number | Valor recebido |
| valorMulta / valorMora / valorDesconto | number | Encargos e descontos aplicados |
| origem | string | api quando você informou a liquidação; cobranca quando a cobrança emitida pela plataforma foi paga |
| parcelasEmAberto | integer | Quantas parcelas restam no contrato |
O evento chega também quando você mesmo liquidou
Se a sua integração é a única a dar baixa, você já sabe do pagamento — mas o evento continua útil como confirmação de que a plataforma registrou. Se houver mais de um canal de baixa (você, operadores na plataforma, cobrança paga), o evento é o que mantém todos alinhados.
credito.contrato.liquidado¶
Disparado quando a última parcela em aberto é baixada. O contrato está quitado.
{
"idWebhook": "019e089e-6785-72cd-38bf-0489a5a2ce61",
"tipoEvento": "credito.contrato.liquidado",
"dataHora": "2028-09-13T19:02:41.377Z",
"grupoEconomico": "MeuGrupo",
"dados": {
"idContrato": 5001,
"idProposta": 1001,
"produto": "ep",
"numeroCcb": "PROP-2026-004821",
"dataLiquidacao": "2028-09-13",
"quantidadeParcelas": 24,
"valorTotalPago": 20400.00
},
"etiquetas": null
}
| Campo | Tipo | Descrição |
|---|---|---|
| dataLiquidacao | string | Data do pagamento da última parcela |
| valorTotalPago | number | Soma de tudo o que foi recebido no contrato |
Este evento é sempre acompanhado de um credito.parcela.liquidada da última parcela. Os dois chegam como disparos independentes, e não necessariamente nessa ordem.
🧭 Fluxo de acompanhamento da carteira¶
⚠️ Observações¶
- Não há baixa automática por conciliação bancária. Em esteiras com cobrança externa, o evento de liquidação só existe porque você informou o pagamento.
- Não há evento de parcela vencida. Para acompanhar atrasos, consulte 7.2. Parcelas e Saldo filtrando por vencimento e status.
- Não há evento de estorno de liquidação. Correções são feitas pelo time de operações na plataforma.