Webhooks - BNPL Reversal

Summary

After creating a reversal request, the system will send webhooks to notify you about the events in the reversal process.

Attention!

Webhooks should not be strictly mapped. New fields may be added to the payload without prior notice.

Cancellation by Reversal Webhook

When the borrower makes the Pix refund payment generated by the reversal, the credit operation is automatically canceled and the following webhook is sent:

WEBHOOK_TYPE

debt

STATUS

canceled

Webhook Body

{
    "webhook_type": "debt",
    "key": "1ebd4a90-2721-4c39-a399-427fa16bca65",
    "event_datetime": "2025-10-27T16:38:59Z",
    "data": {
        "cancel_reason": "Operacao cancelada por estorno",
        "cancel_reason_enumerator": "refund_after_payee_request"
    },
    "status": "canceled"
}

Webhook Fields

Field	Type	Description
webhook_type	string	Webhook type: debt
key	string	Unique debt key (DEBT-KEY)
event_datetime	string	Event date and time
status	string	Event status: canceled
data.cancel_reason	string	Textual description of the cancellation reason
data.cancel_reason_enumerator	string	Cancellation reason enumerator

Reversal-Related Cancellation Enumerators

Enumerator	Description
refund_after_payee_request	Refund requested by the payee
manual	Operation canceled manually
disbursing_error	Operation canceled due to an error during disbursement

---

Transaction Reversal Settlement Webhook

For reversals processed via the transaction_reversal endpoint, the confirmation webhook follows the format below:

WEBHOOK_TYPE

transaction_reversal.transaction_reversal_status_change

STATUS

paid

Webhook Body

{
    "data": {
        "transaction_reversal_key": "b6da1a84-5bb3-4d71-9912-cbbcfe7189c1",
        "amount": 123.45,
        "status": "paid",
        "description": "Valor de liquidação indevido",
        "reference_date": "2025-03-23",
        "fund_class_document_number": "12.345.678/0009-10",
        "fund_class_key": "0619574f-2815-419d-8208-630b0dc30487",
        "source_account": {
            "account_digit": "7",
            "account_branch": "0001",
            "account_number": "0099999",
            "owner": {
                "name": "FUNDO DE INVESTIMENTO",
                "document_number": "12.345.678/0009-10"
            },
            "financial_institution": {
                "code": "329",
                "ispb": "32402502",
                "name": "QI Sociedade de Crédito Direto"
            }
        },
        "target_account": {
            "owner": {
                "name": "Nome fictício",
                "document_number": "111.202.188-99"
            },
            "account_digit": "0",
            "account_branch": "0001",
            "account_number": "1029490",
            "target_pix_key": "1232221",
            "financial_institution": {
                "code": "033",
                "ispb": "90400888",
                "name": "BCO SANTANDER (BRASIL) S.A."
            }
        },
        "external_key": "40054daa-c3c5-49cd-add7-858b576c5887"
    },
    "webhook_type": "transaction_reversal.transaction_reversal_status_change",
    "webhook_datetime": "2025-03-23T15:08:30Z"
}

Transaction Reversal Webhook Fields

Field	Type	Description
webhook_type	string	Webhook type: transaction_reversal.transaction_reversal_status_change
webhook_datetime	string	Webhook send date and time
data.transaction_reversal_key	string	Unique reversal key
data.amount	float	Reversed amount
data.status	string	Reversal status: paid
data.description	string	Reversal description
data.reference_date	string	Processing reference date
data.fund_class_key	string	Fund key
data.source_account	object	Reversal source account details
data.target_account	object	Reversal target account details
data.external_key	string	External key of the reversed transaction