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.

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.

Request Body

{
    "amortization_type": "installment_payment",
    "reference_date": "2022-07-20",
    "discount_percentage": 0.0,
    "operations": [
        {
            "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
            "installments": [
                {
                    "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88"
                }
            ]
        },
        {
            "debt_key": "2cbfb9b1-1gdb-5g8d-9967-b338e5eb83g9",
            "installments": [
                {
                    "installment_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e"
                }
            ]
        }
    ]
}

Body Params

Field	Type	Description	Max. Char.
amortization_type*	string	Amortization type	Amortization Type Enumerators
reference_date*	string	Reference date for present value calculation (must be D+1)	10
discount_percentage	float	Discount percentage on the present value ((1 - percentage) * Present Value)	10
discount_amount	float	Discount amount applied to 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

Amortization Type Enumerators

Field	Description
installment_payment	Renegotiation for payment of specific installments sent in the payload. 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

200

Response Body

{
    "amortization_type": "installment_payment",
    "discount_percentage": 0.0,
    "discount_amount": 0.0,
    "payment_amount": 240,
    "requester_name": "Requester",
    "requester_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
    "issuer_name": "issuer",
    "reference_date": "2022-07-20",
    "issuer_document_number": "98765432100",
    "operations": [
        {
            "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
            "payment_amount": 100,
            "discount_amount": 0,
            "affected_installments": [
                {
                    "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
                    "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": "7ac54a3e-fd11-46b2-b811-4c7d6d158fd5",
                    "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": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e",
                    "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
                }
            ]
        }
    ]
}

Discount Fields

Percentage discount

{
    "discount_percentage": 0.5
}

Absolute discount

{
    "discount_amount": 200
}