# 3.1 还款
# 3.1.1 用户还款试算
# 接口说明：
- 接口由宜信提供，合作方调用。进行单笔还款试算；
# 接口地址：repay.trial
# 请求参数：
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| openId | String | 是 | 用户 ID | |
| applyNo | String | 是 | 合同单号 | |
| repayType | Integer | 是 | 还款类型 | SETTLEMENT：提前结清 DO：正常还款 |
# 响应参数
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| repayTrialDate | String | 是 | 还款试算时间 | yyyy-MM-dd HH:mm:ss |
| repayType | Integer | 是 | 还款类型 | SETTLEMENT：提前结清 DO：正常还款 |
| repayAmount | Long | 是 | 应还总金额 | 单位（分） 公式：总金额=本金+利息+服务费+罚息 |
| repayPrincipal | Long | 是 | 应还总本金 | 单位（分） |
| repayInterest | Long | 是 | 应还总利息 | 单位（分） |
| repayServiceFee | Long | 是 | 应还总服务费 | 单位（分） |
| repayPenalty | Long | 是 | 应还罚息 | 单位（分） |
# 3.1.2 用户还款计划查询
# 接口说明
接口由宜信提供，查询用户下还款计划
# 接口地址: repay.plan
# 请求参数
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| openId | String | 是 | 用户 ID | |
| applyNo | String | 是 | 订单编号 | 宜信借款订单号 |
# 响应参数
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| loanAmount | Long | 是 | 借款金额 | 单位（分） |
| termNum | Integer | 是 | 借款期数 | 总期次 |
| repayPlanList | List | 是 | 每期账单 | 见账单详情 |
| loanStatus | Integer | 是 | 借款状态 | 借款状态： 30:正常还款中 ； 50:已逾期 ； 60:已结清 ； |
| applyTime | String | 是 | 借款申请时间 | 格式： yyyy-MM-dd HH:mm:ss |
| effectiveTime | String | 否 | 借款起息日 | 格式： yyyy-MM-dd |
| clearTime | String | 否 | 结清日时间 | 格式： yyyy-MM-dd HH:mm:ss |
| totalDestAmount | Long | 是 | 总共应还总金额 | 单位（分） 该笔合同的总应还，对应期次中的应还 |
| totalPaidAmount | Long | 是 | 总共实收总金额 | 单位（分） 该笔合同的总实收，对应期次中的实收 |
| totalUnpaidAmount | Long | 是 | 尚欠总金额 | 单位（分） 该笔合同的总尚欠，对应期次中的尚欠 总金额=本金+利息+服务费+罚息 |
| totalUnpaidPrincipal | Long | 是 | 尚欠总本金 | 单位（分） |
| totalUnpaidInterest | Long | 是 | 尚欠总利息 | 单位（分） |
| totalUnpaidServiceFee | Long | 是 | 尚欠总服务费 | 单位（分） |
| totalUnpaidPenalty | Long | 是 | 尚欠罚息 | 单位（分） |
<repayPlanList>账单详情
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| period | Integer | 是 | 期次 | |
| destAmount | Long | 是 | 本期应还总金额 | 单位（分） 总金额=本金+利息+服务费+罚息 |
| destPrincipal | Long | 是 | 本期应还本金 | 单位（分） |
| destInterest | Long | 是 | 本期应还利息 | 单位（分） |
| destServiceFee | Long | 是 | 本期应还服务费 | 单位（分） |
| destPenalty | Long | 是 | 本期应还罚息 | 单位（分） |
| shouldRepayDate | String | 是 | 本期应还款日 | 格式： yyyy-MM-dd |
| shouldBillDate | String | 是 | 本期账单日 | 格式：yyyy-MM-dd |
| paidAmount | Long | 是 | 本期实还金额 | 单位（分） 总金额=本金+利息+服务费+罚息 |
| paidPrincipal | Long | 是 | 本期实还本金 | 单位（分） |
| paidInterest | Long | 是 | 本期实还利息 | 单位（分） |
| paidServiceFee | Long | 是 | 本期实还服务费 | 单位（分） |
| paidPenalty | Long | 是 | 本期实还罚息 | 单位（分） |
| actualRepayTime | String | 否 | 本期实际还款时间 | 格式： yyyy-MM-dd HH:mm:ss |
| unPaidAmount | Long | 是 | 本期尚欠总金额 | 单位（分） 公式=应收-实收 |
| unPaidPrincipal | Long | 是 | 本期尚欠本金 | 单位（分） |
| unPaidInterest | Long | 是 | 本期尚欠利息 | 单位（分） |
| unPaidServiceFee | Long | 是 | 本期尚欠服务费 | 单位（分） |
| unPaidPenalty | Long | 是 | 本期尚欠罚息 | 单位（分） |
| termStatus | Integer | 是 | 本期还款状态 | 本期还款状态 0: 待还款 1: 已逾期 2: 已结清 |
| overdueDays | Integer | 是 | 逾期天数 | 默认0 |
# 3.1.3 用户还款请求
# 接口说明：
用户主动还款
# 接口地址：repay.do
# 请求参数
| 参数 | 类型 | 必填 | 字段标识 | 说明 |
|---|---|---|---|---|
| openId | String | 是 | 用户ID | |
| repayNo | String | 是 | 还款流水号 | |
| applyNo | String | 是 | 合同单号(取消合同(放款前必传)) | |
| repayAmount | Long | 是 | 总还款金额 | 单位：分 |
| repayType | String | 是 | SETTLEMENT：提前结清 DO：正常还款 | |
| cardNo | String | 是 | 银行卡号 | |
| notifyUrl | String | 否 | 还款结果通知地址 |
# 响应参数
| 参数 | 类型 | 必填 | 字段标识 | 说明 |
|---|---|---|---|---|
| repayNo | String | 是 | 还款外部订单号 | |
| applyNo | String | 是 | 合同单号 | |
| repayStatus | String | 是 | 还款状态 REPAYING:还款中 FAIL:还款失败 SUCCESS:还款成功 PART:部分还款成功 | |
| desc | String | 是 | 还款结果描述 | 失败返回失败原因 |
# 3.1.4 还款结果查询
# 接口说明：
查询还款结果
# 接口地址：repay.result
# 请求参数：
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| openId | String | 是 | 用户 ID | |
| repayNo | String | 是 | 宜信平台还款交易流水号 | 还款订单流水号 |
| applyNo | String | 是 | 合同单号 | 合同单号 |
# 响应参数：
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| repayStatus | String | 是 | 还款状态 REPAYING:还款中 FAIL:还款失败 SUCCESS:还款成功 PART:部分还款成功 | |
| repayType | Integer | 是 | 还款类型 | SETTLEMENT：提前结清 DO：正常还款 |
| totalRepayAmount | Long | 是 | 还款金额 | 单位（分） |
| applyNo | String | 是 | 订单编号 | 宜信借款订单号 |
| repayNo | String | 是 | 订单编号 | 宜信还款订单号 |
| repayDate | String | 是 | 还款时间 | yyyy-MM-dd HH:mm:ss |
| repayAmount | Long | 是 | 订单还款金额 | 单位（分） |
| desc | String | 是 | 还款结果描述 | 失败返回失败原因 |
| repayPlanList | List | 否 | 宜信平台还款交易明细 | 宜信平台还款交易明细 |
<repayPlanList>还款明细列表：
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| period | Integer | 是 | 期次 | |
| paidAmount | Long | 是 | 本期还款总额 | 单位（分） 总金额=本金+利息+服务费+罚息 |
| paidPrincipal | Long | 是 | 本期还款本金 | 单位（分） |
| paidInterest | Long | 是 | 本期还款利息 | 单位（分） |
| paidServiceFee | Long | 是 | 本期还款服务费 | 单位（分） |
| paidPenalty | Long | 是 | 本期还款罚息 | 单位（分） |
| termStatus | Integer | 是 | 本期还款状态 | 本期还款状态 0: 待还款 1: 已逾期 2: 已结清 |
# 3.1.5 取消进件
# 接口地址：apply.cancel
# 请求参数
| 参数 | 类型 | 必填 | 字段标识 | 说明 |
|---|---|---|---|---|
| openId | String | 是 | 用户ID | |
| applyNo | String | 是 | 合同号 |
# 响应参数
| 参数 | 类型 | 必填 | 字段标识 | 说明 |
|---|---|---|---|---|
| status | String | 是 | 响应码 | 0000成功；9999失败 |
| desc | String | 否 | 结果描述 |