Pagamentos Recebidos

📦 Webhook: Installment Charge Status Changed

Categoria: Acompanhamento do Pagamentos Recebidos
Evento: Installment Charge Status Changed

Este webhook é acionado quando há uma alteração no status de cobrança de uma parcela, como geração, pagamento, cancelamento ou pagamento parcial.

🔔 Evento

installment.charge.status.changed

📄 Payload

{
  "loanId": "string",
  "paymentPlanId": "string",
  "event": "CREATED | PAID | PARTIALLY_PAID | CANCELLED",
  "installmentNumber": "integer",
  "installment": {
    "number": "integer",
    "dueDate": "date",
    "chargings": [
      {
        "bankSlipInfo": {
          "identificationField": "string"
        },
        "pixInfo": {
          "emv": "string"
        },
        "chargedAmount": "decimal",
        "paidAmount": "decimal",
        "paidAt": "date"
      }
    ]
  }
}

🧾 Descrição dos Campos

Campo	Tipo	Descrição
`loanId`	String	Identificador do empréstimo.
`paymentPlanId`	String	Identificador do plano de pagamentos.
`event`	Enum	Evento de alteração na cobrança. Valores possíveis: `CREATED`, `PAID`, `PARTIALLY_PAID`, `CANCELLED`.
`installmentNumber`	Integer	Número da parcela associada ao evento.
`installment.number`	Integer	Número da parcela.
`installment.dueDate`	Date	Data de vencimento da parcela.
`installment.chargings`	Array	Lista de cobranças emitidas para a parcela.
`chargings[].bankSlipInfo.identificationField`	String	Código de barras do boleto bancário, se houver.
`chargings[].pixInfo.emv`	String	Código "copia e cola" do Pix, se houver.
`chargings[].chargedAmount`	Decimal	Valor total cobrado na cobrança.
`chargings[].paidAmount`	Decimal	Valor efetivamente pago (se houver).
`chargings[].paidAt`	Date	Data do pagamento (se houver).

📘 Exemplo

{
  "loanId": "3520fad8-f0eb-11e9-a713-2a2ae2dbcce4",
  "paymentPlanId": "la1ndad8-f0eb-11e9-a713-2a2ae2ddk5j1",
  "event": "PAID",
  "installmentNumber": 1,
  "installment": {
    "number": 1,
    "dueDate": "2024-02-05",
    "chargings": [
      {
        "pixInfo": {
          "emv": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
        },
        "chargedAmount": 1249.56,
        "paidAmount": 1249.56,
        "paidAt": "2024-02-05"
      }
    ]
  }
}