Criar uma renegociação

Request

ENDPOINT

/renegotiation/proposal

MÉTODO

POST

Request Body

Exemplos de payloads utilizando amortization_types diferentes

Usando chaves de parcelas

{
  "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,
  "discount_amount": 100,
  "installments": [
    {
      "installment_key": "ca5741c7-99a2-42e7-92a1-9328a36e4e88"
    },
    {
      "installment_key": "0ff87136-b084-44fb-8fc2-d2e3beed483b"
    },
    {
      "installment_key": "e4101c6a-51b3-435f-a2b7-4a65a005cc15"
    }
  ]
}

Usando número de parcelas

{ 
  "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",
  "discount_percentage": 0.2,
  "discount_amount": 100,
  "number_of_installments": 4
}

Usando valor final

{ 
  "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",
  "discount_percentage": 0.2,
  "discount_amount": 100,
  "payment_amount": 900
}

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
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
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.
first_installments	Será criada uma renegociação que pagará as primeiras parcelas, em status aberto. Este amortization type pode ser utilizado passando tanto a quantidade de parcelas que deseja quitar (number_of_installments), quanto o valor que o tomador deseja pagar payment_amount).

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

STATUS

201

Response Body

{
  "contract_number": "0001232093/ABC",
  "proposal_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
  "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
    }
  ]
}

STATUS

400

Response Body

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}