Parcelas à Vencer

📦 Webhook: Upcoming Installment Due

Categoria: Acompanhamento das Parcelas à Vencer
Evento: Upcoming Installment Due

Este webhook é acionado quando uma parcela do empréstimo está prestes a vencer, informando os valores esperados, situação de pagamento e projeções para o dia do vencimento.

🔔 Evento

installment.upcoming.due

📄 Payload

{
  "loanId": "string",
  "paymentPlanId": "string",
  "installment": {
    "number": "integer",
    "dueDate": "date",
    "chargedAmount": "decimal"
  },
  "projectedAmountOnDueDate": "decimal",
  "amountRemainingForPayment": "decimal",
  "paymentSituation": "NONE | PARTIAL | FULL"
}

🧾 Descrição dos Campos

Campo	Tipo	Descrição
`loanId`	String	Identificador do empréstimo.
`paymentPlanId`	String	Identificador do plano de pagamentos.
`installment.number`	Integer	Número da parcela.
`installment.dueDate`	Date	Data de vencimento da parcela (formato ISO 8601).
`installment.chargedAmount`	Decimal	Valor total cobrado da parcela.
`projectedAmountOnDueDate`	Decimal	Valor projetado em conta no dia do vencimento da parcela.
`amountRemainingForPayment`	Decimal	Valor restante necessário para a quitação da parcela na data de vencimento.
`paymentSituation`	Enum	Situação do pagamento no vencimento. Valores possíveis:<br>`NONE`, `PARTIAL`, `FULL`.

📘 Exemplo

{
  "loanId": "3520fad8-f0eb-11e9-a713-2a2ae2dbcce4",
  "paymentPlanId": "la1ndad8-f0eb-11e9-a713-2a2ae2ddk5j1",
  "installment": {
    "number": 1,
    "dueDate": "2024-06-01",
    "chargedAmount": 1000
  },
  "projectedAmountOnDueDate": 798.5,
  "amountRemainingForPayment": 201.5,
  "paymentSituation": "PARTIAL"
}