Webhook utilizado para notificar sobre o status de liquidação das transações
A comunicação relacionada à liquidação das cobranças será feita via webhook, onde serão disponibilizadas informações correspondentes ao pagamento.
Webhook
{
"CollectionId": 12345,
"PaymentMethod": "Pix",
"RefundPix": true,
"PaymentDate": "2024-06-13T15:30:00Z",
"PaymentDetails": {
"OriginalValue": 100.00,
"FineValue": 2.50,
"InterestValue": 1.75,
"DiscountValue": 5.00,
"FinalValue": 99.25
}
}Campos do Webhook
| Campo | Tipo | Descrição |
|---|---|---|
clientid | Integer | Identificador do cliente emissor da cobrança |
PaymentMethod | String | Método de Pagamento: Pix Boleto |
RefundPix | String | Houve devolução de pagamento: true (sim); false (não). |
PaymentDate | DateTime | Data em que o pagamento foi efetuado |
PaymentDetails | Object | Detalhes do pagamento realizado |
OriginalValue | Decimal | Valor original da cobrança |
FineValue | Decimal | Valor de multa aplicado |
InterestValue | Decimal | Valor de juros aplicado |
DiscountValue | Decimal | Valor de desconto aplicado |
FinalValue | Decimal | Valor final do pagamento, com aplicação de eventual multa, juros e/ou desconto |
Atenção:
- Com relação ao campo
RefundPix, ele corresponde a informação se houve ou não alguma devolução de pagamento.- A devolução do pagamento ocorre em cenários em que é feito um pagamento duplicado: tanto o QR Code quanto o Boleto forem pagos.
- Nesse cenário, ocorre a devolução do valor pago via QR Code (Pix).