# 4.8 权益
# 4.8.1 权益信息查询
# 接口说明:
- 接口由广告主方提供,宜信调用。查询权益相关信息。
# 接口地址:
rights.info.query
# 请求参数:
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| openId | String | 是 | 用户 ID | |
| orderNo | String | 是 | 授信申请流水号 | |
| amount | Long | 是 | 借款金额 | 单位:分 |
| termNum | Integer | 是 | 借款期数 | 借款期数 |
# 响应参数:
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| msgCode | String | 是 | 状态明细码 | |
| msgDesc | String | 否 | 状态明细描述 | |
| isPackage | String | 是 | 是否展示权益 | 0:不展示; 1:展示; |
| packageType | String | 否 | 权益类型 | 0:非强制权益; 1:强制权益; isPackage=1时必传 |
| packageName | String | 否 | 权益名称 | |
| packageId | String | 否 | 权益包ID | |
| packageInfo | jsonObject | 否 | 权益信息 | |
| packageValue | Long | 否 | 权益价值 | 单位:分 isPackage=1时必传 |
| discountAmount | Long | 否 | 优惠金额 | 单位:分 |
| sellPrice | Long | 否 | 权益售价 | 单位:分 isPackage=1时必传 |
| detailUrl | String | 否 | 权益详情页地址 | isPackage=1时必传 |
| agreementsList | List | 否 | 权益协议列表 | isPackage=1时必传 |
agreementsList 权益协议列表
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| agreementName | String | 是 | 协议名字 | |
| agreementContent | String | 是 | 协议内容 | URL/HTML |
| textType | String | 是 | 内容类型 | textType URL:url HTML:html PDF_URL: pdf格式的文件地址url |
| order | Integer | 否 | 顺序 | 不传默认按照list顺序展示 |
| defaultChosen | boolean | 是 | 是否默认选择 | 默认false |
| forceRead | boolean | 是 | 是否强制阅读 | 默认false |
packageInfo 权益信息
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| highLights | jsonArray | 否 | 权益亮点列表 | 限制数量 [4, 6] |
| lossRights | jsonArray | 否 | 丧失权益列表 | 限制数量 [4, 6] |
highLights 权益亮点列表
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| text | String | 是 | 权益亮点的文字描述 | 长度限制:最大 6 个字符 |
| sort | Integer | 否 | 权益亮点排序 | 未设置默认按列表顺序 |
lossRights 丧失权益列表
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| text | String | 是 | 丧失权益的文字描述 | 长度限制:最大 6 个字符 |
| sort | Integer | 否 | 丧失权益排序 | 未设置默认按列表顺序 |
# 4.8.2 权益订单查询
# 接口说明:
- 接口由广告主方提供,宜信调用。查询用户权益订单最新状态。
# 接口地址:
rights.order.result
# 请求参数:
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| openId | String | 是 | 用户 ID | |
| applyNo | String | 是 | 借款交易流水号 | 业务流水号,保证唯一 |
| orderNo | String | 是 | 授信申请流水号 | |
| loanOrderLentTime | String | 否 | 借款放款时间戳 | |
| loanOrderCreateTime | String | 否 | 借款创建时间戳 |
# 响应参数:
| 参数名称 | 类型 | 是否必须 | 说明 | 备注 |
|---|---|---|---|---|
| msgCode | String | 是 | 状态明细码 | |
| msgDesc | String | 否 | 状态明细描述 | |
| openId | String | 是 | 用户 ID | |
| applyNo | String | 是 | 借款交易流水号 | |
| batchNo | String | 是 | 权益订单号 | |
| packageName | String | 是 | 权益名称 | |
| packageStatus | Integer | 是 | 权益状态 | -1:未开通; 0:待激活; 1:已激活; 2:已取消; 3:过期; |
| termNum | Integer | 是 | 期数 | |
| totalPayAmount | Long | 是 | 权益订单总金额 | 单位:分 |
| createTime | String | 否 | 创建订单时间 | yyyy-MM-dd HH:mm:ss |
| expireTime | String | 否 | 权益过期时间 | yyyy-MM-dd HH:mm:ss |
| activeTime | String | 否 | 权益开通时间 | yyyy-MM-dd HH:mm:ss |
| url | String | 否 | 权益行权地址 | packageStatus=1时必传 |
# msgCode枚举
| code | desc |
|---|---|
| 0000 | 成功 |
| 0001 | 失败 |
| 9999 | 服务异常(系统级异常,需要重试) |