模拟重组方案

请求

ENDPOINT

/renegotiation/simulation

方法

POST

Request Body

使用不同 amortization_types 的 payload 示例

使用分期 key

{
  "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
  "amortization_type": "installment_payment",
  "reference_date": "2022-07-20",
  "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"
    }
  ]
}

使用分期数量

{ 
  "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
  "amortization_type": "first_installments",
  "reference_date": "2022-07-20",
  "discount_percentage": 0.2,
  "discount_amount": 100,
  "number_of_installments": 4
}

使用最终金额

{
  "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
  "amortization_type": "first_installments",
  "reference_date": "2022-07-20",
  "discount_percentage": 0.2,
  "discount_amount": 100,
  "payment_amount": 900
}

注意

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

Body Params

字段	类型	描述	字符
debt_key	string	QI 内信贷操作的唯一 key	UUID
amortization_type	string	摊销类型	摊销类型枚举
reference_date	string	重组现值计算的参考日期（需为 D+1）	10
proposal_due_date	string	重组方案到期日期	10
payment_type	string	支付类型	支付类型枚举
payment_amount	float	方案中协商的最终金额	-
number_of_installments	int	方案中协商的分期数量	10
discount_percentage	float	折扣百分比	10
discount_amount	float	折扣金额	10
installments	array of objects	重组的分期列表	Installments 对象

Installments 数组对象

字段	类型	描述	字符
installment_key	string	待重组分期的 key	uuid 格式

摊销类型枚举（Amortization Type）

字段	描述
installment_payment	创建用于支付 payload 中指定分期的重组方案。 使用此摊销类型时，需传入分期的 installment_key。
overdue_installment_payment	创建专门针对逾期分期支付的重组方案。 使用此摊销类型时，需传入分期的 installment_key。
first_installments	创建用于支付最前面若干期（状态为开放）的重组方案。 此摊销类型可通过传入希望结清的分期数量（number_of_installments）或借款人希望支付的金额（payment_amount）来使用。

响应

状态

201

Response Body

{
  "debt_key": "1baea8a0-0fca-4f7c-8857-a227d4da72f8",
  "discount_percentage": 0.2,
  "payment_amount": 240,
  "origin_key": "76912b4b-508a-4b10-9485-0e87f1316b35",
  "reference_date": "2022-07-20",
  "proposal_due_date": "2022-07-20",
  "requester_name": "Requester Name",
  "amortization_type": "installment_payment",
  "requester_key": "bcc16a6d-ce21-4cd4-8d8c-d26f89ccc685",
  "issuer_name": "issuer",
  "issuer_document_number": "98765432100",
  "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\"}"
}