Consulta - Renegociação em Lote Crédito Clean

Resumo

É possível consultar o status e detalhes de uma proposta de renegociação em lote, utilizando a batch_proposal_key ou a request_control_key.

---

Consultar por Batch Proposal Key

ENDPOINT

/renegotiation/batch_proposal/BATCH-PROPOSAL-KEY

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
batch_proposal_key*	string	Chave da proposta de renegociação em lote	UUID

Response

STATUS

200

Response Body

{
    "batch_proposal_key": "ff5ad6dd-2087-4850-a3e8-b37634448b4e",
    "discount_percentage": 0,
    "discount_amount": 0,
    "amortization_type": "installment_payment",
    "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",
    "batch_proposal_status": "pending_payment",
    "proposal_due_date": "2026-04-15",
    "payment_type": "pix",
    "request_control_key": "94b31045-c8e7-45be-a88d-2ae25c5df5db",
    "origin_key": null,
    "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.49,
                    "interest_amount": 52.4,
                    "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.13,
                    "interest_amount": 27.76,
                    "fine_amount": 0,
                    "total_amount": 543.89
                }
            ],
            "debt_key": "72760166-4ddf-41fb-8a8c-605f8f4fc35c"
        }
    ],
    "payment": {
        "digitable_line": null,
        "qr_code_url": "00020126930014br.gov.bcb.pix2571qrcode-h.sandbox.qitech.app/bacen/cobv/acaeb341e1264cde99b93e247e12b3725204000053039865802BR5925QISOCIEDADEDECREDITODIRET6008SaoPaulo61080145200062070503***63043AD0",
        "qr_code_key": "acaeb341-e126-4cde-99b9-3e247e12b372",
        "bank_slip_key": null,
        "paid_method_type": "pix",
        "source_account_key": null,
        "payment_data": {
            "creditor_bank_account_key": "6108dd45-580d-48c4-b3bb-74c1e843be49",
            "batch_renegotiation_proposal_key": "ff5ad6dd-2087-4850-a3e8-b37634448b4e"
        }
    }
}

---

Consultar por Request Control Key

ENDPOINT

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

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres
request_control_key*	string	Chave de controle da requisição	UUID

Response

A resposta segue o mesmo formato da consulta por batch_proposal_key.

---

Listar Renegociações em Lote

ENDPOINT

/renegotiation/batch_proposal

MÉTODO

GET

Query Params

Campo	Tipo	Descrição
batch_proposal_status	string	Filtrar por status da proposta em lote
issuer_document_number	string	Filtrar por CPF/CNPJ do emitente
request_control_key	string	Filtrar por chave de controle

Response

STATUS

200

Response Body

{
    "data": [
        {
            "batch_proposal_key": "ff5ad6dd-2087-4850-a3e8-b37634448b4e",
            "discount_percentage": 0,
            "discount_amount": 0,
            "amortization_type": "installment_payment",
            "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",
            "batch_proposal_status": "pending_payment",
            "proposal_due_date": "2026-04-15",
            "payment_type": "pix",
            "request_control_key": "94b31045-c8e7-45be-a88d-2ae25c5df5db",
            "origin_key": null
        }
    ],
    "pagination": {
        "current_page": 1,
        "next_page": 2,
        "rows_per_page": 10,
        "total_pages": 150,
        "total_rows": 1495
    }
}

---

Cancelar uma Renegociação em Lote

ENDPOINT

/renegotiation/batch_proposal/BATCH-PROPOSAL-KEY

MÉTODO

DELETE

Path Params

Campo	Tipo	Descrição	Caracteres
batch_proposal_key*	string	Chave da proposta de renegociação em lote a ser cancelada	UUID

Response

STATUS

204

Response Body

{}

Atenção

Somente propostas com status pending_payment podem ser canceladas.