Proposta de Renegociação em Lote - BNPL

Resumo

Após simular os valores, é possível criar uma proposta de renegociação em lote para múltiplas operações BNPL. A proposta gera um único meio de pagamento (boleto e/ou Pix) que cobre todas as operações incluídas no lote.

Atenção

A renegociação em lote só pode ser criada com operações de um mesmo emitente e mesma chave de integração. Há um limite de 50 operações para cada renegociação em lote.

Request

ENDPOINT

/renegotiation/batch_proposal

MÉTODO

POST

Atenção

Os campos discount_amount e discount_percentage NÃO podem ser enviados juntos no mesmo 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

Campo	Tipo	Descrição	Caracteres
amortization_type*	string	Tipo de amortização	Enumeradores Amortization Type
reference_date*	string	Data de referência para cálculo do valor presente (D+1)	10
proposal_due_date*	string	Data de vencimento da proposta de renegociação	10
payment_type*	string	Tipo de pagamento	Enumeradores Payment Type
request_control_key	string	Chave de controle para rastreamento e identificação única (opcional)	UUID
discount_percentage	float	Percentual de desconto sobre o valor presente	10
discount_amount	float	Valor de desconto sobre o valor presente	10
operations*	array	Lista de operações a serem renegociadas	Objeto Operations

Objeto Operations

Campo	Tipo	Descrição	Caracteres
debt_key*	string	Chave única da operação de crédito (DEBT-KEY)	UUID
installments*	array	Parcelas a serem renegociadas	Objeto Installments

Objeto Installments

Campo	Tipo	Descrição	Caracteres
installment_key*	string	Chave da parcela a ser renegociada	UUID

Enumeradores Payment Type

Campo	Descrição
bank_slip	Pagamento via boleto bancário (gera boleto e Pix)
pix	Pagamento via Pix (gera apenas Pix)
manual	Pagamento feito de forma manual (não gera forma de pagamento)

Enumeradores Amortization Type

Campo	Descrição
installment_payment	Renegociação para pagamento de parcelas específicas. Requer installment_key de cada parcela.
overdue_installment_payment	Renegociação direcionada para pagamento de parcelas em atraso. Requer installment_key de cada parcela.

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
                }
            ]
        }
    ]
}

Importante

Salve a batch_proposal_key retornada na resposta. Ela será necessária para consultar o status da renegociação em lote e para receber os webhooks de pagamento.