开放平台

# 4.5 还款

# 4.5.1 用户还款试算

# 接口说明：

  1. 接口由宜信提供，合作方调用。查询用户合同待还款信息；

# 接口地址：

repayTrial

# 请求参数：

参数名称 类型 是否必须 说明 备注
loanNo String 是 三方提现流水号
outerUserNo String 是 用户 ID
repayType Integer 是 还款类型 1-普通还款，2-提前清贷

# 响应参数

参数名称 类型 是否必须 说明 备注
loanNo String 是 三方提现流水号
outerUserNo String 是 用户 ID
totalAmt BigDecimal 是 待还总金额 单位元， 有已出账：取用户所有已出账金额汇总；无已出账：取用户下一期账单应还金额
totalCapital BigDecimal 是 待还总本金 单位：元，无此项填写0
totalInterest BigDecimal 是 待还总利息 单位：元，无此项填写0
totalPenaltyInt BigDecimal 是 待还总罚息 单位：元，无此项填写0
totalOverdueFee BigDecimal 是 待还总逾期费用 单位：元，无此项填写0
totalServiceFee BigDecimal 是 待还总服务费 单位：元，无此项填写0
totalCashFee BigDecimal 是 待还总提现手续费 单位：元，无此项填写0
totalInsuranceFee BigDecimal 是 待还总保费 单位：元，无此项填写0
totalSettleFee BigDecimal 是 待还提前结清手续费 单位：元，无此项填写0
totalOtherFee BigDecimal 是 待还其他费项 单位：元，无此项填写0
repayPlan List<RepayPlan 是 还款计划 List类型

还款计划信息RepayPlan

参数名称 类型 是否必须 说明 备注
term
 Integer 是 期次 示例：12
payDate String 是 应还款日期 yyyy-MM-dd
示例：2020-07-30
termTotalAmt BigDecimal 是 本期应还总额 单位：元，无此项填写0
termCapital BigDecimal 是 本期应还本金 单位：元，无此项填写0
termInterest BigDecimal 是 本期应还利息 单位：元，无此项填写0
termPenaltyInt BigDecimal 是 待还总罚息 单位：元，无此项填写0
termOverdueFee BigDecimal 是 待还总逾期费用 单位：元，无此项填写0
termServiceFee BigDecimal 是 本期应还服务费 单位：元，无此项填写0）
termCashFee BigDecimal 是 本期提现手续费 单位：元，无此项填写0
termInsuranceFee BigDecimal 是 本期担保费 单位：元，无此项填写0
termOtherFee BigDecimal 是 本期其他费用 单位：元，无此项填写0

# 4.5.2 还款发送短信验证码

# 接口说明

接口由宜信提供，合作方调用。合作方通知宜信发送还款短信验证码给用户

# 接口地址:

sendSmsCode

# 请求参数

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
repayType Integer 是 还款类型 0-普通还款，1-提前清贷
repayNo String 是 宜信平台还款交易流水号 还款订单流水号
bindCardId String 是 绑卡Id 4.3.1  绑卡申请中返回的bindCardId
totalRepayAmount Long 是 总还款金额 总还款金额
repayList List 是 还款列表

<repayList> 还款列表：

参数名称 类型 是否必须 说明 备注
applyNo String 是 借款订单号 宜信借款订单号
repayAmount Long 是 订单总还款金额 单位（分）

# 响应参数

参数名称 类型 是否必须 说明 备注
status String 是 发送验证码状态 参考CodeDescEnum 枚举中的status
desc
 String 是 状态描述 参考CodeDescEnum 枚举中的desc
serialNo String 是 验证码序列号
repayNo String 是 宜信平台还款交易流水号 还款订单流水号

CodeDescEnum状态枚举:

status desc
0000 成功
0001 处理中(本接口没有)
9999 其他(具体信息透传)

# 4.5.3 用户还款计划查询

# 接口说明

接口由宜信提供，合作方调用。合作方向宜信发送请求

# 接口地址:

repayPlanQuery

# 请求参数

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
applyNo String 是 订单编号 宜信借款订单号

# 响应参数

参数名称 类型 是否必须 说明 备注
status String 是 查询状态 参考CodeDescEnum 枚举中的status
desc
 String 是 状态具体描述 参考CodeDescEnum 枚举中的desc
loanAmount Long 是 借款金额 单位（分）
termNum Integer 是 借款期数 总期次
repayPlanList List 是 每期账单 见账单详情
loanStatus String 是 借款状态 借款状态：
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 是 尚欠罚息 单位（分）
currentTerm Integer 是 当前期次 当前时间所在的期次

<repayPlanList>账单详情

参数名称 类型 是否必须 说明 备注
period Integer 是 期次
destAmount Long 是 本期应还总金额 单位（分）
总金额=本金+利息+服务费+罚息
destPrincipal Long 是 本期应还本金 单位（分）
destInterest Long 是 本期应还利息 单位（分）
destServiceFee Long 是 本期应还服务费 单位（分）
destPenalty Long 是 本期应还罚息 单位（分）
shouldRepayDate 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 是 本期还款状态
 本期还款状态
1: 未到期
2: 未逾期可还款
3: 已逾期
4: 已结清
overdueDays Integer 是 逾期天数 默认0

# CodeDescEnum状态枚举:

status desc
0000 成功
1001 未发现可查询还款计划的进件
9999 其他(具体信息透传)

# 4.5.4 用户还款请求

# 接口说明：

  1. 接口由宜信提供，合作方调用。合作方向宜信发起还款请求。

# 接口地址：

DoRepay

# 请求参数：

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
repayNo String 是 宜信平台还款交易流水号 还款订单流水号
totalRepayAmount Long 是 总还款金额 单位（分）
repayType Integer 是 还款类型 0-普通还款，1-提前清贷
repayList List 是 还款列表 同 4.5.2 还款发送短信验证码的入参  repayList
bindCardId String 是 绑卡id 4.3.1  绑卡申请中返回的bindCardId
serialNo String 否 验证码序列号
smsCode String 否 短信验证码 快捷支付必须

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 操作状态码 10:请求成功
20:请求失败
msgCode
 string 是 原因描述 参考CodeDescEnum 枚举中的msgCode
msgDesc
 string 是 原因描述 参考CodeDescEnum 枚举中的msgDesc

# CodeDescEnum状态枚举:

msgCode msgDesc
0000 还款成功
0001 还款处理中
1001 未发现待还款进件
1003 不支持该还款类型
4001 该还款流水号不能重复提交
4002 有一笔还款正在处理中，请稍后进行还款
4003 有一笔借款正在划扣中，请稍后进行还款
4004 该还款卡不存在
4005 该银行不支持还款
9999 其他(具体信息透传)

# 4.5.5  还款结果查询

# 接口说明：

  1. 接口由宜信提供，合作方调用。合作方查询用户还款结果。

# 接口地址：

repayResultQuery

# 请求参数：

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
repayNo String 是 宜信平台还款交易流水号 还款订单流水号

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 还款状态：
 10: 还款中
20: 还款失败
30: 还款成功
40: 部分还款成功
msgCode
 String 是 查询状态 参考CodeDescEnum 枚举中的msgCode
msgDesc
 String 是 状态描述 参考CodeDescEnum 枚举中的msgDesc
repayType Integer 是 还款类型 0-普通还款，1-提前清贷
totalRepayAmount Long 是 还款金额 单位（分）
repayResultList List 是 还款订单结果列表 返回还款成功的订单列表

<repayResultList>还款订单结果列表

参数名称 类型 是否必须 说明 备注
applyNo String 是 订单编号 宜信借款订单号
repayAmount Long 是 订单还款金额 单位（分）
repayPlanList List 是 还款明细列表 还款成功时返回
loanStatus String 是 借款状态 30:正常还款中 ；
50:已逾期 ；
60:已结清 ；
status String 是 订单的还款状态 10: 还款中
20: 还款失败
30: 还款成功
desc String 是 还款结果描述 失败返回失败原因

<repayPlanList>还款明细列表：

参数名称 类型 是否必须 说明 备注
period Integer 是 期次
paidAmount Long 是 本期还款总额 单位（分）
总金额=本金+利息+服务费+罚息
paidPrincipal Long 是 本期还款本金 单位（分）
paidInterest Long 是 本期还款利息 单位（分）
paidServiceFee Long 是 本期还款服务费 单位（分）
paidPenalty Long 是 本期还款罚息 单位（分）
termStatus Integer 是 本期还款状态 本期还款状态
1: 未到期
2: 未逾期可还款
3: 已逾期
4: 已结清

# CodeDescEnum状态枚举:

msgCode msgDesc
0000 查询成功
5001 没有还款记录
9999 其他(具体信息透传)

# 4.5.6 还款结果回调通知

# 接口说明：

  1. 接口由合作方提供，宜信调用。宜信调用接口通知合作方还款申请结果最新状态。

# 接口地址：

repayResultNotify

# 请求参数：

参数名称 类型 是否必须 说明 备注
repayNo String 否 宜信平台还款交易流水号 宜信平台还款交易订单号，主动还款必须，系统划扣不填
outerUserNo String 是 用户 ID
repayType Integer 是 还款类型 0-普通还款，1-提前清贷
repayMethod Integer 是 还款方式 1.主动还款
2.系统划扣
3.线下对公入账
cardNo String 否 还款卡号 卡号：系统划扣时、必传
status String 是 还款状态：
 20: 还款失败
30: 还款成功
40: 部分还款成功
desc String 是 还款结果描述 失败返回失败原因
totalRepayAmount Long 是 总还款金额 单位（分）
repayResultList List 是 还款订单结果列表 返回还款成功的订单列表

repayResultList还款订单结果列表

参数名称 类型 是否必须 说明 备注
applyNo String 是 订单编号 宜信借款订单号
repayAmount Long 是 订单还款金额 单位（分）
repayPlanList List 是 还款明细列表 还款成功时返回
loanStatus String 是 借款状态 30:正常还款中 ；
50:已逾期 ；
60:已结清 ；
status String 是 该订单的还款状态 10: 还款中
20: 还款失败
30: 还款成功
desc String 是 还款结果描述 失败返回失败原因

repayPlanList还款明细列表

参数名称 类型 是否必须 说明 备注
period Integer 是 期次
paidAmount Long 是 本期还款总额 单位（分）
总金额=本金+利息+服务费+罚息
paidPrincipal Long 是 本期还款本金 单位（分）
paidInterest Long 是 本期还款利息 单位（分）
paidServiceFee Long 是 本期还款服务费 单位（分）
paidPenalty Long 是 本期还款罚息 单位（分）
termStatus Integer 是 本期还款状态 本期还款状态
1: 未到期不可还款
2: 未逾期可还款
3: 已逾期
4: 已结清

# 响应参数：

参数名称 类型 是否必须 说明 备注
status
 String 是 回调结果 参考CodeDescEnum 状态枚举中的status
desc
 String 是 回调结果描述 参考CodeDescEnum 状态枚举中的desc
outerUserNo String 是 用户 ID
repayNo String 是 宜信平台还款交易订单号 还款订单流水号

# CodeDescEnum 状态枚举:

status desc
0000 回调成功
9999 其他(具体信息透传)

# 4.5.7 还款记录查询

# 接口说明：

  1. 接口宜信提供，合作方调用。查询用户所有还款记录，包含合作方主动发起，在宜信发起以及代扣的所有还款流水单。

备注： 可以按照合同订单编号，也可按照宜信平台还款交易订单号查询

# 接口地址：

repayRecord

# 请求参数：

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
repayNo String 否 宜信平台还款交易订单号 还款订单流水号
applyNo String 否 订单编号 宜信借款订单号

# 响应参数

参数名称 类型 是否必须 说明 备注
status
 String 是 查询状态 参考CodeDescEnum状态描述的status
desc
 String 是 状态描述 参考CodeDescEnum状态描述的desc
outerUserNo Long 是 用户 ID
totalNum Integer 是 还款记录总数
repayRecords List 是 还款记录详情 见还款记录详情

repayRecords还款记录详情

参数名称 类型 是否必须 说明 备注
repayNo String 否 宜信平台还款交易订单号 还款订单流水号（手动还款必填）
repayType Integer 是 还款类型 0-普通还款，1-提前清贷
repayWay Integer 是 还款方式 1-主动还款，2-系统划扣， 3-线下对公入账
repayDate String 是 还款日期 格式:
yyyy-MM-dd
totalRepayAmount Long 是 总还款金额 单位（分）
repayResultList List 是 还款订单列表 还款订单列表
status String 是 还款状态 10: 还款中
20: 还款失败
30: 还款成功
40: 部分还款成功
desc String 是 还款结果描述 失败返回失败原因

repayResultList还款订单列表

参数名称 类型 是否必须 说明 备注
applyNo String 是 订单编号 宜信借款订单号
repayAmount Long 是 订单还款金额 单位（分）
repayPlanList List 是 还款明细列表 还款明细列表
status String 是 还款状态 10: 还款中
20: 还款失败
30: 还款成功
desc String 是 还款结果描述 失败返回失败原因

repayPlanList还款明细列表

参数名称 类型 是否必须 说明 备注
period Integer 是 期次
paidAmount Long 是 本期还款总额 单位（分）
总金额=本金+利息+服务费+罚息
paidPrincipal Long 是 本期还款本金 单位（分）
paidInterest Long 是 本期还款利息 单位（分）
paidServiceFee Long 是 本期还款服务费 单位（分）
paidPenalty Long 是 本期还款罚息 单位（分）
termStatus Integer 是 本期还款状态 本期还款状态
1: 未到期
2: 未逾期可还款
3: 已逾期
4: 已结清

# CodeDescEnum 状态枚举:

status desc
0000 查询成功
5001 没有还款记录
9999 其他(具体信息透传)

# 4.5.8 还款地址查询

# 接口说明：

  1. 接口宜信提供，合作方调用。返回宜信的还款URL，跳到宜信进行还款

# 接口地址：

repayUrl

# 请求参数：

参数名称 类型 是否必须 说明 备注
outerUserNo String 是 用户 ID
applyNo String 是 订单编号 宜信借款订单号

# 响应参数

参数名称 类型 是否必须 说明 备注
status
 String 是 查询状态 参考CodeDescEnum状态描述的status
desc
 String 是 状态描述 参考CodeDescEnum状态描述的desc
repayUrl String 是 还款URL 渠道提供的还款URL ，跳到渠道还款页面进行还款

# 还款地址url响应示例

 {
 "msg": "success",
 "code": 0,
 "params": "{\"status\":\"0000\",\"desc\":\"成功\",\"repayUrl\":\"http://bjtestldp.xiaoying.com/partner/h5/partner/auth?token=dbe924d8-a952-45ef-862a-f762dd887736&redirectUrl=http%3A%2F%2Fbjtestldp.xiaoying.com%2Ffe%2Fldp%2FloanDetail%2Findex.html%3FuserName%3D183******72\"}"
 }
1
2
3
4
5

# CodeDescEnum 状态枚举:

status desc
0000 查询成功
1001 该笔订单不存在
9999 其他(具体信息透传)
上次更新: 2 年前

← 4.6 合同 →