跳到主要内容

创建重组方案

请求​

ENDPOINT
/renegotiation/proposal
方法
POST
Request Body

使用不同 amortization_types 的 payload 示例

{
  "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,
  "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"
    }
  ]
}
注意

discount_amount 和 discount_percentage 字段不能在同一 payload 中同时发送。

Body Params​

字段类型描述字符
debt_keystringQI 内信贷操作的唯一 keyUUID
amortization_typestring摊销类型摊销类型枚举
reference_datestring重组现值计算的参考日期（需为 D+1）10
proposal_due_datestring重组方案到期日期10
payment_typestring支付类型支付类型枚举
payment_amountfloat方案中协商的最终金额-
number_of_installmentsint方案中协商的分期数量10
discount_percentagefloat基于重组现值计算的折扣百分比（(1 - 折扣百分比) * 现值）10
discount_amountfloat基于重组现值的折扣金额（现值 - 总折扣金额）10
request_control_keystring用于追踪和唯一标识的请求控制 keyUUID
installmentsarray of objects重组的分期列表Installments 对象

摊销类型枚举（Amortization Type）​

字段描述
installment_payment创建用于支付 payload 中指定分期的重组方案。

使用此摊销类型时，需传入分期的 installment_key。
overdue_installment_payment创建专门针对逾期分期支付的重组方案。

使用此摊销类型时，需传入分期的 installment_key。
first_installments创建用于支付最前面若干期（状态为开放）的重组方案。

此摊销类型可通过传入希望结清的分期数量（number_of_installments）或借款人希望支付的金额（payment_amount）来使用。

支付类型枚举（Payment Type）​

字段描述
bankslip通过银行划款支付（同时生成划款和 Pix 支付）
pix通过 Pix 支付（仅生成 Pix）
manual手动支付（不生成支付方式）

Installments 对象​

字段类型描述字符
installment_keystring待重组分期的 keyuuid 格式

响应​

状态
201
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": [...],
  "remaining_installments": [...]
}
状态
400
Response Body
{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}