Skip to main content

Simulation - BNPL Batch Renegotiation

Overview

Before creating a renegotiation proposal, you can simulate the batch renegotiation values for BNPL operations. The simulation allows you to view the affected installments, discount values, and the final amount to be paid for multiple operations simultaneously.

With amortization_type set to present_amount, send in each installment of operations[].installments[] the fields paid_amount, discount_amount and installment_key, just like in the batch proposal.

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_simulation
METHOD
POST
Attention

The fields discount_amount and discount_percentage CANNOT be sent together in the same payload (root level).

Note

At the root level, discount_amount and discount_percentage are alternatives for a global discount. The paid_amount and discount_amount fields in operations[].installments[] are used with present_amount per installment and do not replace the root-level rule.

Request Body
{
"amortization_type": "present_amount",
"reference_date": "2026-04-08",
"discount_percentage": 0.0,
"operations": [
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
"paid_amount": 500,
"discount_amount": 50
}
]
},
{
"debt_key": "2cbfb9b1-1fdb-5f8d-9967-b338e5eb83f9",
"installments": [
{
"installment_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e",
"paid_amount": 150,
"discount_amount": 10
}
]
}
]
}

Body Params

FieldTypeDescriptionMax. Char.
amortization_type*stringAmortization typeAmortization Type Enumerators
reference_date*stringReference date for present value calculation (must be D+1)10
discount_percentagefloatDiscount percentage on the present value ((1 - percentage) * Present Value)10
discount_amountfloatDiscount amount applied to the present value10
operations*arrayList of operations to be renegotiatedOperations Object

Operations Object

FieldTypeDescriptionMax. Char.
debt_key*stringUnique key of the credit operation (DEBT-KEY)UUID
installments*arrayInstallments to be renegotiatedInstallments Object

Installments Object

FieldTypeDescriptionMax. Char.
installment_key*stringKey of the installment to be renegotiatedUUID
paid_amountfloatAmount paid (or allocated) on the installment, in BRL (R$). Required when amortization_type is present_amount.15,2
discount_amountfloatDiscount amount in BRL (R$) on the installment. Required when amortization_type is present_amount (use 0 if there is no discount). Optional for other types.15,2

Amortization Type Enumerators

FieldDescription
present_amountSimulation with present value per installment. In each installments[], installment_key, paid_amount and discount_amount are required.
installment_paymentRenegotiation for payment of specific installments sent in the payload. Requires the installment_key of each installment.
overdue_installment_paymentRenegotiation targeted at overdue installment payment. Requires the installment_key of each installment.

Response

STATUS
200
Response Body
{
"batch_proposal_key": "7423c701-3578-4733-8f30-81ab60afdb6d",
"discount_percentage": 0,
"discount_amount": 0,
"amortization_type": "present_amount",
"payment_amount": 517.88,
"requester_name": "Dante Ltda",
"requester_key": "78287247-947d-4730-9bd1-7efb068175b6",
"issuer_name": "Dante Ferrarini",
"reference_date": "2026-04-08",
"issuer_document_number": "31057466093",
"operations": [
{
"requester_key": "78287247-947d-4730-9bd1-7efb068175b6",
"contract_number": "DWF1761222116",
"payment_amount": 517.88,
"discount_amount": 0,
"origin_key": null,
"affected_installments": [
{
"installment_key": "1dea396f-beb1-4df3-9822-35800b4c095a",
"due_date": "2026-05-07",
"principal_amount": 491.4903841,
"interest_amount": 52.3996159,
"fine_amount": 0,
"total_amount": 543.89,
"present_amount": 517.88,
"paid_amount": 517.88,
"principal_amortization_payment_amount": 491.49,
"prefixed_interest_payment_amount": 26.39,
"fine_payment_amount": 0,
"discount_amount": 0
}
],
"remaining_installments": [
{
"installment_key": "370e73d1-55d8-431e-9b22-d08fb8297999",
"due_date": "2026-06-07",
"principal_amount": 516.1296159,
"interest_amount": 27.7603841,
"fine_amount": 0,
"total_amount": 543.89
}
],
"debt_key": "72760166-4ddf-41fb-8a8c-605f8f4fc35c"
}
]
}

Discount Fields

Percentage discount
{
"discount_percentage": 0.5
}
Absolute discount
{
"discount_amount": 200
}