Fatura

Enviado quando uma parcela de fatura é paga via PIX no link de pagamento da parcela. Enquanto restarem parcelas em aberto, o evento é INVOICE_INSTALLMENT_PAID. Quando a parcela paga é a última em aberto, a fatura é totalmente quitada e o evento passa a ser INVOICE_FULLY_PAID. Assine os eventos invoice.installment_paid e invoice.fully_paid para receber estas notificações.

Campo	Tipo	Descrição
`event`	`string`	`INVOICE_INSTALLMENT_PAID` (há parcelas em aberto) ou `INVOICE_FULLY_PAID` (fatura quitada)
`invoiceId`	`string`	ID da fatura
`installmentId`	`string`	ID da parcela paga
`installmentNumber`	`number`	Número da parcela paga (1, 2, 3…)
`transactionId`	`string`	ID da transação PIX que pagou a parcela
`value`	`number`	Valor pago (em reais)
`paidAt`	`string`	Data e hora do pagamento (ISO 8601)

Exemplo — Parcela paga (ainda há parcelas em aberto):

{
  "event": "INVOICE_INSTALLMENT_PAID",
  "invoiceId": "01961234-abcd-7000-8000-000000000006",
  "installmentId": "01961234-abcd-7000-8000-000000000007",
  "installmentNumber": 1,
  "transactionId": "01961234-abcd-7000-8000-000000000008",
  "value": 100.50,
  "paidAt": "2025-03-08T15:30:00.000Z"
}

Exemplo — Fatura totalmente paga (última parcela):

{
  "event": "INVOICE_FULLY_PAID",
  "invoiceId": "01961234-abcd-7000-8000-000000000006",
  "installmentId": "01961234-abcd-7000-8000-000000000009",
  "installmentNumber": 3,
  "transactionId": "01961234-abcd-7000-8000-00000000000a",
  "value": 100.50,
  "paidAt": "2025-03-08T15:30:00.000Z"
}

Pagamento duplicado: se uma parcela já quitada receber um novo pagamento (por exemplo, um PIX feito a partir de um link antigo), o valor é registrado como pagamento duplicado na parcela para conferência no painel, mas nenhum evento de webhook é enviado — o evento é disparado apenas no pagamento que efetivamente quita a parcela.

Parcela vencida (`INVOICE_INSTALLMENT_OVERDUE`)

Enviado quando uma parcela ultrapassa a data de vencimento sem pagamento. A verificação ocorre automaticamente em horário comercial. Assine o evento invoice.installment_overdue para receber esta notificação. Este payload não possui transactionId, pois a parcela ainda não foi paga.

Campo	Tipo	Descrição
`event`	`string`	Sempre `INVOICE_INSTALLMENT_OVERDUE`
`invoiceId`	`string`	ID da fatura
`installmentId`	`string`	ID da parcela vencida
`installmentNumber`	`number`	Número da parcela vencida
`installmentCount`	`number`	Total de parcelas da fatura
`value`	`number`	Valor da parcela (em reais)
`dueDate`	`string`	Data de vencimento (ISO 8601)

Exemplo:

{
  "event": "INVOICE_INSTALLMENT_OVERDUE",
  "invoiceId": "01961234-abcd-7000-8000-000000000006",
  "installmentId": "01961234-abcd-7000-8000-000000000007",
  "installmentNumber": 1,
  "installmentCount": 3,
  "value": 100.50,
  "dueDate": "2025-03-05T00:00:00.000Z"
}

Pagamentos

Conta

Webhooks

IA e automação

Parcela vencida (`INVOICE_INSTALLMENT_OVERDUE`)

​Parcela vencida (INVOICE_INSTALLMENT_OVERDUE)

Parcela vencida (`INVOICE_INSTALLMENT_OVERDUE`)