Criar uma renegociação
Request
Request Body
Exemplos de payloads utilizando amortization_types diferentes
- Informando as parcelas e uma data de referência
- Informando as parcelas e o valor de quitação
- Quitando as primeiras N parcelas
- Utilizando um valor para amortizar primeiras parcelas
- Amortizando igualmente as parcelas
- Informando valor de quitação do contrato
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "installment_payment",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"discount_percentage": 0.2,
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88"
},
{
"installment_key": "0ff87136-b084-44fb-8fc2-d2e3beed483b"
},
{
"installment_key": "e4101c6a-51b3-435f-a2b7-4a65a005cc15"
}
]
}
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "installment_payment",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
"paid_amount":120
},
{
"installment_key": "0ff87136-b084-44fb-8fc2-d2e3beed483b",
"paid_amount":130.0
},
{
"installment_key": "e4101c6a-51b3-435f-a2b7-4a65a005cc15",
"paid_amount":160.2
}
]
}
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "first_installments",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"number_of_installments": 4
}
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "first_installments",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"payment_amount": 900
}
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "equal_amount",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"payment_amount": 900
}
{
"debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
"payment_type": "bank_slip",
"amortization_type": "full_settle",
"reference_date": "2022-07-20",
"proposal_due_date": "2022-07-20",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"payment_amount": 900
}
1. tipos de payment_type
1.1 bankslip
Este tipo de pagamento gera uma linha digitável e um pix qr code para serem pagos, ficando a cargo do tomador escolher qual utilizar para realizar o pagamento.
1.2 pix
Este tipo de pagamento gera somente um pix qr code para ser pago.
2. tipos de amortization_type
2.1 installment_payment
Este método de amortização recebe uma lista de parcelas que devem ser totalmente quitadas pela renegociação, o valor de quitação das parcelas pode ser calculado de duas formas:
Valor presente
O valor de quitação de cada parcela é calculado utilizando a reference_date informada como data de referência para o cálculo do valor presente. (compatível com disconto)
Valor informado
O valor de quitação é informado no payload para cada parcela, a reference_date é ignorada. (não compatível com disconto)
2.2 first_installments
Este método de amortização seleciona as primeiras parcelas em aberto (vencidas ou não) de um contrato para amortizar, a seleção da quantidade parcelas pode ocorrer de duas formas:
Quantidade de parcelas
A quantidade de parcelas que serão quitadas é selecionada pelo campo number_of_installments, o valor da renegociação é calculado com base na reference_date. (não compatível com disconto)
Valor de amortização
É informado um valor de amortização (payment_amount) que é distribuido nas parcelas abertas seguindo a ordem de vencimento e as trazendo a valor presente na reference_date, eventualmente pode ser que uma das parcelas seja quitada parcialmente. (não compatível com disconto)
2.3 equal_amount
Este método de amortização recebe um valor a ser amortizado (payment_amount) e o distribui igualmente nas parcelas. Não é recomendado para todos os produtos de emissão de crédito, alinhe com o time de operações. (não compatível com disconto)
2.4 full_settle
Este método de amortização recebe um valor de quitação do contrato.(não compatível com disconto)
3. Disconto
Para alguns métodos de amortização, é possível adicionar um desconto ao cálculo que pode ser informado em valor absoluto (discount_amount) ou percentual (discount_percentage).
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 |
payment_amount | float | Valor final renegociado na proposta. | - |
number_of_installments | int | Número de Parcelas renegociadas na proposta. | 10 |
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 |
request_control_key | string | Chave de controle da requisição para rastreamento e identificação única. | UUID |
installments | array of objects | Parcelas renegociadas. | Installments Object |
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) |
Installments Object
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
installment_key | string | key da parcela a ser renegociada | chave uuid |
Response
Response Body
{
"contract_number": "0001232093/ABC",
"proposal_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
"request_control_key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"proposal_status": "pending_payment",
"amortization_type": "installment_payment",
"discount_percentage": 0.2,
"payment_amount": 300,
"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",
"origin_key": "76912b4b-508a-4b10-9485-0e87f1316b35",
"payment": {
"digitable_line": "32990001031000700298993000000203110340000004618",
"qr_code_url": "mockurl.com.br",
"qr_code_key": "f02c201d-314e-42be-968c-a48776d98fbf",
"bank_slip_key": "931a989d-66e9-4631-abaa-b413610afb85",
"paid_method_type": "bank_slip"
},
"affected_installments": [
{
"installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88",
"due_date": "2023-01-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100,
"paid_amount": 80
},
{
"installment_key": "0ff87136-b084-44fb-8fc2-d2e3beed483b",
"due_date": "2022-12-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100,
"paid_amount": 80
},
{
"installment_key": "e4101c6a-51b3-435f-a2b7-4a65a005cc15",
"due_date": "2022-11-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125,
"present_amount": 100,
"paid_amount": 80
}
],
"remaining_installments": [
{
"installment_key": "03b4d86a-9dba-40fc-a4db-33e8772b7be8",
"due_date": "2022-08-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125
},
{
"installment_key": "c622efa6-8731-464b-a563-a7a26c19279d",
"due_date": "2022-09-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125
},
{
"installment_key": "3da60b56-17fb-4b32-a1e4-1f0c28d18905",
"due_date": "2022-10-01",
"principal_amount": 100,
"interest_amount": 20,
"fine_amount": 5,
"total_amount": 125
}
]
}
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}