Batch Renegotiation Proposal - BNPL

Overview

After simulating the values, you can create a batch renegotiation proposal for multiple BNPL operations. The proposal generates a single payment method (bank slip and/or Pix) that covers all operations included in the batch.

Attention

Batch renegotiation can only be created with operations from the same issuer and the same integration key. There is a limit of 50 operations per batch renegotiation.

Request

ENDPOINT

/renegotiation/batch_proposal

METHOD

POST

Attention

The fields discount_amount and discount_percentage CANNOT be sent together in the same payload.

Request Body

{
    "amortization_type": "installment_payment",
    "reference_date": "2022-07-20",
    "proposal_due_date": "2022-07-20",
    "discount_percentage": 0.0,
    "payment_type": "bank_slip",
    "request_control_key": "4f75374c-e02f-4459-bddc-b9a7a0c9b0f3",
    "operations": [
        {
            "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
            "installments": [
                {
                    "installment_key": "767f6ce0-add7-4334-a843-0e82cd1e7360"
                }
            ]
        },
        {
            "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
            "installments": [
                {
                    "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e89"
                }
            ]
        }
    ]
}

Body Params

Field	Type	Description	Max. Char.
amortization_type*	string	Amortization type	Amortization Type Enumerators
reference_date*	string	Reference date for present value calculation (D+1)	10
proposal_due_date*	string	Due date for the renegotiation proposal	10
payment_type*	string	Payment type	Payment Type Enumerators
request_control_key	string	Control key for tracking and unique identification (optional)	UUID
discount_percentage	float	Discount percentage on the present value	10
discount_amount	float	Discount amount on the present value	10
operations*	array	List of operations to be renegotiated	Operations Object

Operations Object

Field	Type	Description	Max. Char.
debt_key*	string	Unique key of the credit operation (DEBT-KEY)	UUID
installments*	array	Installments to be renegotiated	Installments Object

Installments Object

Field	Type	Description	Max. Char.
installment_key*	string	Key of the installment to be renegotiated	UUID

Payment Type Enumerators

Field	Description
bank_slip	Payment via bank slip (generates bank slip and Pix)
pix	Payment via Pix (generates Pix only)
manual	Manual payment (does not generate a payment method)

Amortization Type Enumerators

Field	Description
installment_payment	Renegotiation for payment of specific installments. Requires the installment_key of each installment.
overdue_installment_payment	Renegotiation targeted at overdue installment payment. Requires the installment_key of each installment.

Response

STATUS

201

Response Body

{
    "batch_proposal_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
    "batch_proposal_status": "pending_payment",
    "amortization_type": "installment_payment",
    "discount_percentage": 0.0,
    "discount_amount": 0.0,
    "payment_amount": 240,
    "requester_name": "Requester",
    "requester_key": "0193d113-9abd-4a13-8edb-2d94c2fdb70b",
    "issuer_name": "issuer",
    "reference_date": "2022-07-20",
    "proposal_due_date": "2022-07-20",
    "issuer_document_number": "98765432100",
    "payment_type": "bank_slip",
    "request_control_key": "4f75374c-e02f-4459-bddc-b9a7a0c9b0f3",
    "payment": {
        "digitable_line": "",
        "qr_code_url": "",
        "qr_code_key": "",
        "bank_slip_key": "",
        "paid_method_type": null
    },
    "operations": [
        {
            "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
            "payment_amount": 100,
            "discount_amount": 0,
            "affected_installments": [
                {
                    "installment_key": "767f6ce0-add7-4334-a843-0e82cd1e7360",
                    "due_date": "2022-05-01",
                    "principal_amount": 100,
                    "interest_amount": 20,
                    "fine_amount": 5,
                    "total_amount": 125,
                    "present_amount": 100,
                    "paid_amount": 100
                }
            ],
            "remaining_installments": [
                {
                    "installment_key": "6807c8ee-8deb-40da-9b39-653d64ee8db7",
                    "due_date": "2022-08-01",
                    "principal_amount": 100,
                    "interest_amount": 20,
                    "fine_amount": 5,
                    "total_amount": 125
                }
            ]
        },
        {
            "debt_key": "2cbfb9b1-1gdb-5g8d-9967-b338e5eb83g9",
            "payment_amount": 140,
            "discount_amount": 0,
            "affected_installments": [
                {
                    "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e89",
                    "due_date": "2022-05-01",
                    "principal_amount": 100,
                    "interest_amount": 20,
                    "fine_amount": 5,
                    "total_amount": 200,
                    "present_amount": 140,
                    "paid_amount": 140
                }
            ],
            "remaining_installments": [
                {
                    "installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18907",
                    "due_date": "2022-08-01",
                    "principal_amount": 100,
                    "interest_amount": 20,
                    "fine_amount": 5,
                    "total_amount": 125
                }
            ]
        }
    ]
}

Important

Save the batch_proposal_key returned in the response. It will be needed to check the batch renegotiation status and to receive payment webhooks.