BNPL Reversal

Summary

The reversal of a BNPL operation allows you to reverse the disbursement. There are two cancellation/reversal scenarios:

1. Cancellation before disbursement: Cancels the operation before the funds are transferred
2. Reversal after disbursement (up to 7 days): Generates a Pix refund so the borrower can return the funds

---

1. Cancellation Before Disbursement

Cancels a credit operation that has not yet been disbursed.

Request

ENDPOINT

/debt/DEBT-KEY/cancel

METHOD

PATCH

Test in Playground

Path Params

Field	Type	Description	Max. Char.
debt_key*	string	Unique debt key returned at the time of the credit operation creation	UUID

Response

STATUS

200

Response Body

{
    "data": [
        {
            "borrower": {
                "document_number": "68394265057",
                "name": "Xuxa Meneguel"
            },
            "contract_fee_amount": 5.56,
            "installments": [
                {
                    "bank_slip_key": null,
                    "calendar_days": 57,
                    "due_date": "2020-09-30",
                    "due_principal": -0.00217819,
                    "fine_amount": null,
                    "has_interest": true,
                    "installment_key": "28eb5907-ed25-4a86-bb9d-b6dc944f13df",
                    "installment_number": 1,
                    "installment_status": "opened",
                    "installment_type": "principal",
                    "paid_amount": 0,
                    "post_fixed_amount": 0,
                    "pre_fixed_amount": 268.75782181,
                    "principal_amortization_amount": 1111.9,
                    "tax_amount": 0,
                    "total_amount": 1380.66,
                    "workdays": 40
                }
            ],
            "operation_key": "7986dcc7-4331-478f-af47-adfbdf7f4a36",
            "status": "opened"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 100,
        "total_pages": 1,
        "total_rows": 55
    }
}

Attention

This endpoint can only be used for operations that have not yet been disbursed. For already disbursed operations, use the reversal endpoint below.

---

2. Reversal After Disbursement (Up to 7 Days)

Reverses a BNPL operation that has already been disbursed, within 7 calendar days after disbursement. The system generates a copy-and-paste Pix code so the borrower can return the funds.

Request

ENDPOINT

/debt/reversal

METHOD

POST

Test in Playground

Request Body

{
    "contract_number": "0000049343/TW"
}

Body Params

Field	Type	Description	Max. Char.
contract_number*	string	CCB contract number	-

Response

STATUS

200

Response Body

{
    "amount": "2026.93",
    "copy_paste_pix": "00020126930014br.gov.bcb.pix2571qrcode-h.dev.qitech.app/bacen/cobv/dece8d3e-32ce-439e-8204000053039865802BR5925Joao61080150400062070503***63046ECD",
    "expiration_date": "2022-09-28",
    "payer_document_number": "000000000008",
    "payer_name": "Teste",
    "reversal_key": "f98a1b7c-5e3c-4e6f-8887-c7fedfa0d5b5",
    "status": "waiting_payment"
}

Response Details

Field	Type	Description
amount	string	Total amount to be returned
copy_paste_pix	string	Pix copy-and-paste code for fund return
expiration_date	string	Expiration date of the refund Pix
payer_document_number	string	Borrower's CPF/CNPJ
payer_name	string	Borrower's name
reversal_key	string	Unique reversal key
status	string	Reversal status: waiting_payment

Important

• Reversal can only be performed within 7 calendar days after disbursement
• The generated copy_paste_pix has an expiration date. After this date, the Pix can no longer be used
• After the borrower pays the Pix, the operation will be automatically canceled and you will receive a cancellation webhook