开放平台

# 4.4 借款

# 4.4.1 借款试算

# 接口说明：

  1. 接口由合作渠道提供，宜信调用。根据用户选择的借款金额、期数、还款方式， 合作渠道返回还款计划。

# 接口地址：

loan.trial

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
orderNo String 是 授信申请流水号
amount Long 是 借款金额 单位为分
示例：500000
表示 5000元
termNum Integer 是 借款期数 借款期数
productNo Integer 否 合作渠道产品编号
pricingType String 是 定价类型 INTEREST_24：24定价
INTEREST_36：36定价
INTEREST_24_WITH_RIGHTS：24+权益定价
INTEREST_36_WITH_RIGHTS：36+权益定价(已废弃)

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 借款试算返回状态码 0000：成功 0001：失败
desc String 否 失败描述 错误描述
termNum Integer 是 借款期次（成功时必传） 总期次
interestType Integer 否 计息方式 见计息方式枚举
compositeRate String 是 综合年化利率（成功时必传） 示例：19.92 表示19.92%
repayPrincipal Long 是 应还本金总额（成功时必传） 单位 （分）
totalInterest Long 是 应还利息总额（成功时必传） 单位 （分）
totalServiceFee Long 是 应还服务费总额（成功时必传） 单位 （分）
repayPenalty Long 否 应还罚息 单位 （分）
repayDate String 是 首次还款日（成功时必传） yyyy-MM-dd 示例：2020-07-30
repayPlanList List<RepayPlanItem> 是 还款计划（成功时必传） 详见还款计划列表

# 借款试算响应示例

 {
 	"msg": "success",
 	"code": 0,
 	"data": "{\"status\":\"0000\",\"termNum\":12,\"interestType\":10,\"compositeRate\":\"36.54\",\"repayPrincipal\":300000,\"totalInterest\":12493,\"totalServiceFee\":50160,\"repayDate\":\"2021-05-26\",\"repayPlanList\":[{\"period\":1,\"shouldRepayDate\":\"2021-05-26\",\"termAmount\":30221,\"termPrincipal\":24141,\"termInterest\":1900,\"termServiceFee\":4180},{\"period\":2,\"shouldRepayDate\":\"2021-06-26\",\"termAmount\":30221,\"termPrincipal\":24294,\"termInterest\":1747,\"termServiceFee\":4180},{\"period\":3,\"shouldRepayDate\":\"2021-07-26\",\"termAmount\":30221,\"termPrincipal\":24448,\"termInterest\":1593,\"termServiceFee\":4180},{\"period\":4,\"shouldRepayDate\":\"2021-08-26\",\"termAmount\":30221,\"termPrincipal\":24603,\"termInterest\":1438,\"termServiceFee\":4180},{\"period\":5,\"shouldRepayDate\":\"2021-09-26\",\"termAmount\":30221,\"termPrincipal\":24758,\"termInterest\":1283,\"termServiceFee\":4180},{\"period\":6,\"shouldRepayDate\":\"2021-10-26\",\"termAmount\":30221,\"termPrincipal\":24915,\"termInterest\":1126,\"termServiceFee\":4180},{\"period\":7,\"shouldRepayDate\":\"2021-11-26\",\"termAmount\":30221,\"termPrincipal\":25073,\"termInterest\":968,\"termServiceFee\":4180},{\"period\":8,\"shouldRepayDate\":\"2021-12-26\",\"termAmount\":30221,\"termPrincipal\":25232,\"termInterest\":809,\"termServiceFee\":4180},{\"period\":9,\"shouldRepayDate\":\"2022-01-26\",\"termAmount\":30221,\"termPrincipal\":25392,\"termInterest\":649,\"termServiceFee\":4180},{\"period\":10,\"shouldRepayDate\":\"2022-02-26\",\"termAmount\":30221,\"termPrincipal\":25552,\"termInterest\":489,\"termServiceFee\":4180},{\"period\":11,\"shouldRepayDate\":\"2022-03-26\",\"termAmount\":30221,\"termPrincipal\":25714,\"termInterest\":327,\"termServiceFee\":4180},{\"period\":12,\"shouldRepayDate\":\"2022-04-26\",\"termAmount\":30222,\"termPrincipal\":25878,\"termInterest\":164,\"termServiceFee\":4180}]}"
 }
1
2
3
4
5

== 还款计划信息RepayPlanItem ==

参数名称 类型 是否必须 说明 备注
period
 Integer 是 期次 示例：12
shouldRepayDate String 是 应还款日期 yyyy-MM-dd
示例：2020-07-30
termAmount Long 是 本期应还总额 单位（分）
termPrincipal Long 是 本期应还本金 单位（分）
termInterest Long 是 本期应还利息 单位（分）
termServiceFee Long 是 本期应还服务费 单位（分）
termPenalty Long 否 本期应还罚息 单位（分）

注意说明：

除利息之外的费用，都算进服务费，服务费可为0 公式：totalAmount =repayPrincipal +totalInterest +totalServiceFee

# 4.4.2 借款申请

# 接口说明：

  1. 接口由合作渠道提供，宜信调用。宜信提交用户选择的借款金额、期数、还款方式、用途、银行卡等信息，提交提交合作渠道借款申请审核；
  2. 如果【借款试算】中，返回需要短验，此接口作用为：广告主生成借款单。

# 接口地址：

loan.apply

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
orderNo String 是 授信申请流水号
applyNo String 是 借款交易流水号 业务流水号，保证唯一
loanAmount BigDecimal 是 借款金额 单位 分
termNum Integer 是 借款期数 示例： 3
loanUse String 是 借款用途 参考枚举项
5.1借款用途
示例：10
loanCardNo String 是 放款卡号
rePayCardNo String 是 还款卡号 与4.3.1绑卡一致
smsCode String 否 短信验证码 (特定资金会传入)
faceCmpScore String 否 人脸分数 例如：80.0000
(特定资金会传入)
livePhoto String[200] 否 活体检测照片 活体检测照片base64
(特定资金会传入)
provider String 否 服务提供商 例如:旷世,腾讯
(特定资金会传入)
collectionTime String 否 活体采集时间 yyyy-MM-dd HH:mm:ss
pricingType String 是 定价类型 INTEREST_24：24定价
INTEREST_36：36定价
INTEREST_24_WITH_RIGHTS：24+权益定价
INTEREST_36_WITH_RIGHTS：36+权益定价(已废弃)
loanOrderCreateTime String 是 借款创建时间 yyyy-MM-dd HH:mm:ss
packageId String 否 权益包ID (用户勾选权益时特定资金会传入)

# 响应参数

参数名称 类型 是否必须 说明 备注
batchNo String 否 响应的流水号 合作渠道产生
status String 是 借款状态 无需短信：
10：放款中，20：放款取消，30：放款成功，40：放款失败
需短信：
01：申请成功，40：放款失败=申请失败
isNeedSms Integer 否 是否需要短信验证码 0：不需要; 1：需要;
msgCode String 是 状态明细码
msgDesc String 否 状态明细描述

# 借款申请响应示例

 {
 	"msg": "success",
 	"code": 0,
 	"data": "{\"status\":\"10\"}"
 }
1
2
3
4
5

# msgCode枚举

code desc
0010 放款处理中
0011 放款处理中，需要增验信息
0020 放款取消
0030 放款成功
0040 放款失败，提现额度超限
0041 放款失败，提现次数超限
0042 放款失败，重复提交
0043 放款失败，不存在授信通过记录
0044 银行卡异常
0045 放款失败，参数校验不合法
0046 放款失败，审核拒绝
0047 申请失败（发送短信时，申请订单失败返回）
9999 服务异常（系统级异常，需要重试）

# 4.4.3 发送短信验证码（2025年起无需对接）

# 接口说明

接口由广告主提供，宜信调用。用于借款时需要验证用户身份发送短验证码。

# 接口地址:

loan.sms.code.send

# 请求参数

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 是 借款交易流水号 业务流水号，保证唯一

# 响应参数

参数名称 类型 是否必须 说明 备注
msgCode String 是 发送验证码状态 参考MsgCodeDescEnum 枚举中的msgCode
msgDesc String 是 状态描述 参考MsgCodeDescEnum 枚举中的msgDesc
serialNo String 是 短信验证码序列号 重发短信生成新的流水号

MsgCodeDescEnum状态枚举:

msgCode msgDesc
0000 成功
9999 其他(具体信息透传)

# 4.4.4 验证短信&放款（2025年起无需对接）

# 接口说明

接口由广告主提供，宜信调用。用于验证用户的短信，并且触发放款操作。

# 接口地址:

loan.sms.code.verify

# 请求参数

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 是 宜信平台借款交易流水号
serialNo String 是 验证码序列号 4.4.3中广告主返回的serialNo
smsCode String 是 短信验证码

# 响应参数

响应参数同4.4.2 loan.apply一致。

参数名称 类型 是否必须 说明 备注
batchNo String 否 响应的流水号 合作渠道产生
status String 是 借款状态 10：放款中，20：放款取消（重新获取资金源的场景，例如：资金A 放款失败，需要切换资金B，这时放款取消，同时恢复额度），30：放款成功，40：放款失败
isNeedSms Integer 否 是否需要短信验证码 0：不需要; 1：需要;
短信发送失败，则返回isNeedSms=1，status=40.
短信发送成功：则返回isNeedSms= 0
msgCode String 是 状态明细码
msgDesc String 否 状态明细描述

# 4.4.5 借款申请结果查询

# 接口说明：

接口由合作渠道提供，宜信调用。查询用户借款申请的最新结果。

# 接口地址：

loan.apply.result

# 请求参数

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 是 借款交易流水号
orderNo String 是 授信申请流水号 如果渠道方applyNo查不到的话可以用orderNo来查
batchNo String 否 合作渠道响应流水号

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 借款状态 10：放款中，20：放款取消（重新获取资金源的场景，例如：资金A 放款失败，需要切换资金B，这时放款取消，同时恢复额度），30：放款成功，40：放款失败
msgCode String 是 状态明细码
msgDesc String 否 状态明细描述
termNum Integer 否 借款期数 非未放款必填
totalAmount Long 否 应还总额 非未放款必填，单位 （分）
loanAmount Long 否 借款金额 单位 （分）
lentTime String 否 放款成功时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
applyTime String 否 借款申请时间 格式：yyyy-MM-dd HH:mm:ss
nextRepayDate String 否 下一个还款日期 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
effectiveTime String 否 起息时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
dayRate String 否 日利率 放款成功必填
示例：0.06 【即0.06%】
compositeRate String 否 综合年化利率 非未放款必填
initialOrCompoundLoans Integer 否 首复贷标识 1：首贷；2：复贷

# 借款申请结果查询响应示例

  {
 	"msg": "success",
 	"code": 0,
 	"data": "{\"status\":\"30\",\"msgCode\":\"0000\",\"msgDesc\":\"放款成功\",\"termNum\":3,\"totalAmount\":424477,\"loanAmount\":400000,\"nextRepayDate\":\"2021-05-26 00:00:00\"}"

 }
1
2
3
4
5
6

# msgCode枚举

code desc
0010 放款处理中
0011 放款处理中，需要增验信息
0020 放款取消
0030 放款成功
0040 放款失败，提现额度超限
0041 放款失败，提现次数超限
0042 放款失败，重复提交
0043 放款失败，不存在授信通过记录
0044 银行卡异常
0045 放款失败，参数校验不合法
0046 放款失败，审核拒绝
9999 服务异常（系统级异常，需要重试）

# 4.4.6 借款申请结果回调

# 接口说明：

  1. 接口由宜信提供，合作渠道调用。合作渠道调用接口通知给宜信借款申请结果最新状态；

# 接口地址：

loan.apply.callback

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 是 借款交易流水号
batchNo String 否 合作渠道响应流水号
status String 是 借款状态 10：放款中，20：放款取消，30：放款成功，40：放款失败
msgCode String 是 状态明细码
msgDesc String 否 状态明细描述
termNum Integer 是 借款期数
totalAmount Long 是 应还总额 单位 （分）
loanAmount Long 否 借款金额 单位 （分）
lentTime String 否 放款成功时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
applyTime String 否 借款申请时间 格式：yyyy-MM-dd HH:mm:ss
nextRepayDay String 否 下一个还款日期 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
effectiveTime String 否 起息时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
dayRate String 否 日利率 放款成功必填
示例：0.06 【即0.06%】
compositeRate String 是 综合年化利率
initialOrCompoundLoans Integer 否 首复贷标识 1：首贷；2：复贷
pricingType String 否 定价类型 INTEREST_24：24定价
INTEREST_36：36定价
INTEREST_24_WITH_RIGHTS：24+权益定价
INTEREST_36_WITH_RIGHTS：36+权益定价(已废弃)
不填默认INTEREST_36

# 响应参数：

参数名称 类型 是否必须 说明 备注
msgCode String 是 状态明细码 0000: 处理成功
0002: 处理失败
msgDesc String 否 状态明细描述

# 借款申请结果回调响应示例

  {
 	"openId": "545a7f0e7b614e5faca13c9ca3e0618c",
 	"applyNo": "DIVERSIONLOAN_72a3846fda034b20b53924752da77629",
 	"status": "10",
 	"msgCode": "0010",
 	"msgDesc": "放款中",
 	"termNum": 6,
 	"totalAmount": 221386,
 	"loanAmount": 200000
 }
1
2
3
4
5
6
7
8
9
10

# 4.4.7 订单状态变更回调

# 接口说明：

  1. 接口由宜信提供，合作渠道调用。当借款订单发生变化时，调用通知宜信，不包括还款结果，还款结果由4.5.6 还款结果回调接口通知，目前该接口可用于，结清、逾期、取消状态变更。

# 接口地址：

order.change.callback

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 否 借款交易流水号
orderNo String 是 授信申请流水号
batchNo String 否 合作渠道响应流水号
status String 是 状态 20：取消，30：放款成功，50：逾期，60：结清

# 响应参数：

参数名称 类型 是否必须 说明 备注
msgCode String 是 状态明细码 0000: 处理成功 0002: 处理失败
msgDesc String 否 状态明细描述

# 4.4.8 半流程借款申请

# 接口说明：

1、调用合作方的借款申请，获得合作方的借款url页面

# 接口地址：

semi.loan.apply

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 是 借款交易流水号 业务流水号，保证唯一
phone String 否 用户手机号 用户手机号

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 状态 0000：处理成功；0002：处理失败
batchNo String 否（成功时必填） 响应的合作方借款流水号
url String 否（成功时必填） 合作方借款页url

# 4.4.9 半流程借款申请回调

# 接口说明：

1、在合作方的订单，没有经过宜享花，合作方回调借款结果

# 接口地址：

semi.loan.apply.callback

# 请求参数：

参数名称 类型 是否必须 说明 备注
openId String 是 用户 ID
applyNo String 否（从宜信发起的借款必传） 宜信侧流水号
orderNo String 是 授信申请流水号
batchNo String 是 合作渠道响应流水号
status String 是 借款状态 10：放款中，20：放款取消，30：放款成功，40：放款失败
msgCode String 是 状态明细码
msgDesc String 否 状态明细描述
termNum Integer 是 借款期数
totalAmount Long 是 应还总额 单位 （分）
loanAmount Long 是 借款金额 单位 （分）
loanUsage String 否 借款用途
lentTime String 否 放款成功时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
nextRepayDay String 否 下一个还款日期 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
effectiveTime String 否 起息时间 放款成功必填
格式：yyyy-MM-dd HH:mm:ss
dayRate String 否 日利率 放款成功必填
示例：0.06 【即0.06%】
compositeRate String 是 综合年化利率
loanCardNo String 否 放款卡号
rePayCardNo String 否 还款卡号 与4.3.1绑卡一致

# 响应参数：

参数名称 类型 是否必须 说明 备注
status String 是 状态 0000：处理成功；0002：处理失败
上次更新: 12 天前

← 4.5 还款 →