Inquiry - BNPL Batch Renegotiation

Overview

You can query the status and details of a batch renegotiation proposal using the batch_proposal_key or the request_control_key.

---

Query by Batch Proposal Key

ENDPOINT

/renegotiation/batch_proposal/BATCH-PROPOSAL-KEY

METHOD

GET

Path Params

Field	Type	Description	Max. Char.
batch_proposal_key*	string	Batch renegotiation proposal key	UUID

Response

STATUS

200

Response Body

{
    "batch_proposal_key": "7ac54a3e-fd11-46b2-b811-4c7d6d158fd5",
    "request_control_key": "61905b8b-3ed2-46bc-8e9c-a5e99ceaea37",
    "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": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
    "issuer_name": "issuer",
    "reference_date": "2022-07-20",
    "proposal_due_date": "2022-07-20",
    "issuer_document_number": "98765432100",
    "payment_type": "bank_slip",
    "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": "3da60b56-17fb-4b32-a1e4-1f0c28d18903",
                    "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": "34f81236-e24a-4788-88e0-86cd697c36b7",
                    "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": "44cad2ae-60e9-4eb8-bb2a-b37e9557873f",
                    "due_date": "2022-08-01",
                    "principal_amount": 100,
                    "interest_amount": 20,
                    "fine_amount": 5,
                    "total_amount": 125
                }
            ]
        }
    ]
}

---

Query by Request Control Key

ENDPOINT

/renegotiation/batch_proposal/request_control_key/REQUEST-CONTROL-KEY

METHOD

GET

Path Params

Field	Type	Description	Max. Char.
request_control_key*	string	Request control key	UUID

Response

The response follows the same format as the query by batch_proposal_key.

---

List Batch Renegotiations

ENDPOINT

/renegotiation/batch_proposal

METHOD

GET

Query Params

Field	Type	Description
batch_proposal_status	string	Filter by batch proposal status
issuer_document_number	string	Filter by issuer CPF/CNPJ
request_control_key	string	Filter by control key

Response

STATUS

200

Response Body

{
    "data": [
        {
            "batch_proposal_key": "7eba74fb-e893-40ac-91bb-9a9d8f8108d7",
            "request_control_key": "cb55f099-d7cf-4b0a-9ddb-8e3ac3fefe8e",
            "batch_proposal_status": "pending_payment",
            "amortization_type": "installment_payment",
            "discount_percentage": 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-25",
            "proposal_due_date": "2022-07-25",
            "issuer_document_number": "98765432100",
            "payment_type": "bank_slip"
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": null,
        "rows_per_page": 100,
        "total_pages": 1,
        "total_rows": 1
    }
}

---

Cancel a Batch Renegotiation

ENDPOINT

/renegotiation/batch_proposal/BATCH-PROPOSAL-KEY

METHOD

DELETE

Path Params

Field	Type	Description	Max. Char.
batch_proposal_key*	string	Key of the batch renegotiation proposal to be canceled	UUID

Response

STATUS

204

Response Body

{}

Attention

Only proposals with status pending_payment can be canceled.