Webhooks - BNPL Batch Renegotiation

Overview

After creating a batch renegotiation proposal, the system will send webhooks to notify about the payment or rejection of the proposal.

Attention!

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

Payment Webhook

This webhook is sent when payment for the batch renegotiation proposal is confirmed.

WEBHOOK_TYPE

renegotiation.batch_proposal

STATUS

paid

Webhook Body

{
    "webhook_type": "renegotiation.batch_proposal",
    "key": "<BATCH-PROPOSAL-KEY>",
    "event_datetime": "<DATA E HORA DO ENVIO DO WEBHOOK>",
    "status": "paid",
    "data": {
        "paid_method_type": "<METODO DE PAGAMENTO>",
        "paid_in": {
            "code_number": "<CODIGO DO BANCO LIQUIDANTE>",
            "ispb": "<ISPB DO BANCO LIQUIDANTE>",
            "name": "<NOME DO BANCO LIQUIDANTE>"
        }
    }
}

Payment Webhook Fields

Field	Type	Description
webhook_type	string	Webhook type: renegotiation.batch_proposal
key	string	Batch renegotiation proposal key (BATCH-PROPOSAL-KEY)
event_datetime	string	Date and time when the webhook was sent
status	string	Event status: paid
data.paid_method_type	string	Payment method used
data.paid_in.code_number	string	Settling bank code
data.paid_in.ispb	string	Settling bank ISPB
data.paid_in.name	string	Settling bank name

paid_method_type Enumerators

Enumerator	Description
bank_slip	Payment made via bank slip
pix	Payment made via Pix

---

Rejection Webhook

A batch renegotiation may be rejected due to payment deadline expiration or an installment payment made outside of the renegotiation.

WEBHOOK_TYPE

renegotiation.batch_proposal

STATUS

rejected

Webhook Body

{
    "webhook_type": "renegotiation.batch_proposal",
    "key": "<BATCH-PROPOSAL-KEY>",
    "event_datetime": "<DATA E HORA DO ENVIO DO WEBHOOK>",
    "status": "rejected",
    "data": {}
}

Attention

A batch renegotiation may be rejected due to:

• Deadline expiration: payment was not made by the due date (proposal_due_date)
• External payment: an installment included in the renegotiation was paid outside of the batch before payment confirmation

---

Installment Payment Data

When an installment is paid through a batch renegotiation, the payment data is recorded in the installment:

Payment Data

{
    "batch_renegotiation_proposal_key": "f9addba2-ec91-41bf-a150-c59eb1c3fbef",
    "paid_in": {
        "ispb": "18236120",
        "name": "NU PAGAMENTOS - IP",
        "code_number": 260
    },
    "resource_account_key": "ea44b9f2-ad00-4896-b8a3-b1a3da28a72f"
}

Payment Data Fields

Field	Type	Description
batch_renegotiation_proposal_key	string	Batch renegotiation proposal key that originated the payment
paid_in.ispb	string	ISPB of the bank used for payment
paid_in.name	string	Name of the bank used for payment
paid_in.code_number	integer	Code of the bank used for payment
resource_account_key	string	Key of the resource account that received the payment