Renegociação em 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.
ATENÇÃO
Há um limite de 50 operações para cada renegociação em lote.
1. Simular uma renegociação em lote
Request
ENDPOINT
/renegotiation/batch_proposal_simulationMÉTODO
POSTRequest 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"
}]
}
]
}
Response
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
}
]
}
]
}
Campos de desconto
Adicionar um destes campos na requisição permite definir um valor de desconto percentual ou absoluto na criação ou simulação da proposta de renegociação.
Desconto percentual
{
"discount_percentage": 0.5
}
Desconto absoluto
{
"discount_amount": 200
}
2. Criar uma renegociação em lote
ATENÇÃO
O Campo 'request_control_key' é livre e opcional e possui a finalidade de garantir a unicidade das requisições.
Request
ENDPOINT
/renegotiation/batch_proposalMÉTODO
POSTRequest 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"
}]
}
]
}
Atenção
Os campos discount_amount e discount_percentage NÃO podem ser enviados juntos no mesmo payload.
Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
debt_key | string | Chave única da operação de crédito dentro da QI. | UUID |
amortization_type | string | Tipo de amortização. | Enumeradores Amortization Type |
reference_date | string | Data referencia a qual valor presente será calculado da renegociação (precisa ser 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 |
discount_percentage | float | Percentual de desconto que será calculado sobre o valor presente da renegociação ((1 - percentual de desconto) * Valor Presente). | 10 |
discount_amount | float | Valor de desconto que será aplicado sobre o valor presente da renegociação (Valor Presente - Valor Bruto Descontado). | 10 |
installments | array of objects | Parcelas renegociadas. | Installments Object |
Enumeradores Amortization Type
| Campo | Descrição |
|---|---|
| installment_payment | Será criada uma renegociação para o pagamento de parcelas distintas enviadas no payload. Para a utilização deste amortization type, é necessário passar a installment_key da parcela. |
| overdue_installment_payment | Será criada uma renegociação direcionado para o pagamento de parcelas em atraso. Para a utilização deste amortization type, é necessário passar a installment_key da parcela. |
Enumeradores Payment Type
| Campo | Descrição |
|---|---|
| bankslip | Pagamento via boleto bancário (gera pagamento boleto e o Pix) |
| pix | Pagamento via Pix (gera apenas Pix) |
| manual | Pagamento feito de forma manual (não gera forma de pagamento) |
Installments Object
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
installment_key | string | key da parcela a ser renegociada | chave uuid |
Response
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
}
]
}
]
}
3. Listar renegociações em lote
Path params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
batch_proposal_status * | string | Status proposta de renegociação em lote. | - |
issuer_document_number * | string | Número de documento do emitente | - |
request_control_key * | string | Chave de identificação do solicitante | - |
Request
ENDPOINT
/renegotiation/batch_proposalMÉTODO
GETResponse 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"
},
{
"batch_proposal_key": "272d1b0f-c06d-47c0-943b-812609ff2e6f",
"request_control_key": "2ef25ed8-7124-44f5-9e3d-1d1a7196166e",
"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-20",
"proposal_due_date": "2022-07-20",
"issuer_document_number": "98765432100",
"payment_type": "bank_slip"
}
],
"pagination": {
"current_page": 1,
"next_page": 2,
"rows_per_page": 2,
"total_pages": 5,
"total_rows": 140
}
}
4. Consultar uma renegociação em lote
Request
ENDPOINT
/renegotiation/batch_proposal/BATCH-PROPOSAL-KEYMÉTODO
GETResponse 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
}
]
}
]
}
5. Cancelamento de uma renegociação em lote
ENDPOINT
/renegotiation/batch_proposal/BATCH-PROPOSAL-KEYMÉTODO
DELETEResponse
ENDPOINT
/renegotiation/batch_proposal/BATCH-PROPOSAL-KEYMÉTODO
DELETEHTTP STATUS
204Response Body
{}
6. Webhooks
6.1. Webhook de pagamento de renegociação em lote
Webhook Body
{
"webhook_type": "renegotiation.batch_proposal",
"key": "\<BATCH-PROPOSAL-KEY\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "paid",
"data": {
"paid_method_type": "<METODO DE PAGAMENTO>",
"paid_in": {
"code_number": "<CODIGO DO BANCO LIQUIDANTE>",
"ispb": "<ISPB DO BANCO LIQUIDANTE>",
"name": "<NOME DO BANCO LIQUIDANTE>"
}
}
}
6.2. Webhook de rejeição de renegociação em lote
ATENÇÃO
Uma renegociação em lote pode ser rejeitada pelo decurso de prazo do pagamento ou por um pagamento de parcela por fora da renegociação.
Webhook Body
{
"webhook_type": "renegotiation.batch_proposal",
"key": "\<BATCH-PROPOSAL-KEY\>",
"event_datetime": "\<DATA E HORA DO ENVIO DO WEBHOOK\>",
"status": "rejected",
"data": {}
}
6.3. Exemplo de payment data da installment paga através de renegociação em lote
Webhook Body
{
"batch_renegotiation_proposal_key": "f9addba2-ec91-41bf-a150-c59eb1c3fbef",
"paid_in": {
"ispb": "18236120",
"name": "NU PAGAMENTOS - IP",
"code_number": 260
},
"resource_account_key": "ea44b9f2-ad00-4896-b8a3-b1a3da28a72f"
}