# 4.6 合同

# 4.6.1 获取协议

# 接口说明：

接口由广告主提供，宜信调用。在授信、绑卡、借款环节宜信可调用该接口，拉取需展示给用户的协议。

# 接口地址：

agreement.query

# 请求参数：

参数名称	类型	是否必须	说明	备注
openId	String	是	用户 ID
agreementType	String	是	协议场景类型	注册:REGISTER 贷前:PRE_LOAN（授信环节对客展示协议）授信:CREDIT 绑卡:BIND（借款环节对客展示协议）借款:LOAN（借款环节对客展示协议）当前仅有贷前，绑卡，借款协议
flowId	String	是	宜信流水号	表示当前预览协议的唯一流水，以供协议签约用
extendInfo	jsonObject	否	扩展字段	根据业务需求确定

扩展字段extendInfo

参数名称	类型	是否必须	说明
transNo	String	否	业务编号
name	String	否	用户姓名
idNo	String	否	用户身份证号
mobileNo	String	否	用户手机号
bankCardNo	String	否	收款银行卡号
loanAmount	String	否	借款金额
totalTerms	String	否	借款期数
orderNo	String	否	授信单号

# 响应参数：

参数名称	类型	是否必须	说明	备注
msgCode	String	是	结果	参考CodeDescEnum状态枚举中的msgCode
msgDesc	String	是	结果描述	参考CodeDescEnum状态枚举中的msgDesc
outerFlowId	String	否	三方协议返回的流水号
agreementsList	List	是	协议列表	见<agreementsList>协议列表

# 协议响应示例

{
	"msg": "success",
	"code": 0,
	"data": "{\"msgCode\":\"0000\",\"msgDesc\":\"获取协议预览成功\",\"outerFlowId\":\"@id\",\"agreementsList\":[{\"agreementName\":\"用户服务协议\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/userServiceAgreement.html?partner=YIXINAPI\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"隐私协议\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/privacyAgreement.html?partner=YIXINAPI\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"个人信息查询及使用授权书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/v1/personInfoAgreement.html?partner=YIXINAPI&orderType=apply&flowId=&expireTime=1619530916643&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=473bb8d0926dc2c26f53fa2ed7384b4a\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"征信系统授权书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/v1/creditAuthorization.html?partner=YIXINAPI&orderType=apply&flowId=&expireTime=1619530916643&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=473bb8d0926dc2c26f53fa2ed7384b4a\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"中裔个人信用信息查询报送授权书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/personInfoAgreementZy.html?partner=YIXINAPI&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=e90ffc6c3e0027a253710b8b07b516c1\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"中裔融资担保服务申请书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/guaranteeApplyZy.html?partner=YIXINAPI&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=e90ffc6c3e0027a253710b8b07b516c1\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"签章授权书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/signatureAuthorization.html?partner=YIXINAPI&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=e90ffc6c3e0027a253710b8b07b516c1\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false},{\"agreementName\":\"非在校大学生承诺书\",\"agreementContent\":\"http://bjtestldp.xiaoying.com/partner/agreements/nonCollegeStudentCommitment.html?partner=YIXINAPI&contractFieldKey=preLoan-b1902b97b9f4473fa93019b530a8b0bf&sign=e90ffc6c3e0027a253710b8b07b516c1\",\"textType\":\"url\",\"defaultChosen\":false,\"forceRead\":false}]}"
  }

1
2
3
4
5

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

# CodeDescEnum 状态枚举:

msgCode	msgDesc
0000	获取协议预览成功
9999	获取协议预览失败

# 4.6.2 协议签约（暂无需对接）

# 接口说明：

接口广告主提供，宜信调用。根据已有的预览协议进行签约

# 接口地址：

agreement.sign

# 请求参数：

参数名称	类型	是否必须	说明	备注
openId	String	是	用户 ID
flowId	String	是	宜信流水号	参照4.6.1中请求的的协议预览唯一流水，协议签约用
outerFlowId	String	否	4.6.1接口中三方返回的流水号

# 响应参数：

参数名称	类型	是否必须	说明	备注
msgCode	String	是	结果	参考CodeDescEnum状态枚举中的msgCode
msgDesc	String	是	结果描述	参考CodeDescEnum状态枚举中的msgDesc
isCallBack	boolean	是	是否回调签约结果	true:签约异步返回结果，真实的结果回调宜信,参照4.6.4的接口 false:签约同步返回结果

# CodeDescEnum 状态枚举:

msgCode	msgDesc
0000	签署成功
9999	签署失败

# 4.6.3 协议下载

# 接口说明：

接口广告主提供，宜信调用。根据已有的预览协议返回的流水下载该流水号下的所有合同；

# 接口地址：

agreement.download

# 请求参数：

参数名称	类型	是否必须	说明	备注
openId	String	是	用户 ID
agreementType	String	是	协议场景类型	注册:REGISTER 贷前:PRE_LOAN 授信:CREDIT 绑卡:BIND 借款:LOAN（放款成功后将签章协议返回，例如：https://*****，供宜享花下载）当前仅下载借款协议类型
flowId	String	是	宜信流水号	agreementType=LOAN时、该接口的flowId为借款编号
outerFlowId	String	否	4.6.1接口中三方返回的流水号

# 响应参数:

参数名称	类型	是否必须	说明	备注
msgCode	String	是	结果	参考CodeDescEnum状态枚举中的msgCode
msgDesc	String	是	结果描述	参考CodeDescEnum状态枚举中的msgDesc
agreementsList	List	是	协议列表	见<agreementsList>协议列表

agreementsList 协议列表

参数名称	类型	是否必须	说明	备注
agreementFileName	String	是	协议文件名称
agreementFileType	String	否	协议文件类型	URL:文件已url格式返回，需要自行下载 BYTE:文件以byte[]的base64编码格式字符串返回如果不传默认是BYTE类型解析
agreementFile	String	是	单个协议	单个协议的内容
agreementCode	String	否	文件的code

# CodeDescEnum 状态枚举:

msgCode	msgDesc
0000	成功
9999	失败

# 4.6.4 协议签约结果回调通知（暂无需对接）

# 接口说明：

接口宜信提供，广告主调用。广告主调用宜信接口通知签约的最终状态

# 接口地址：

/confirmSign/result

# 请求参数：

参数名称	类型	是否必须	说明	备注
openId	String	是	用户 ID
outerFlowId	String	是	4.6.1接口中三方返回的流水号
msgCode	String	是	结果	参考RequestCodeDescEnum状态枚举中的msgCode
msgDesc	String	是	结果描述	参考RequestCodeDescEnum状态枚举中的msgDesc

# 响应参数：

参数名称	类型	是否必须	说明	备注
msgCode	String	是	结果	参考ResponseCodeDescEnum状态枚举中的msgCode
msgDesc	String	是	结果描述	参考ResponseCodeDescEnum状态枚举中的msgDesc

# RequestCodeDescEnum 状态枚举:

msgCode	msgDesc
0000	签署成功
9999	签署失败

# ResponseCodeDescEnum 状态枚举:

msgCode	msgDesc
0000	响应成功
9999	响应失败

← 4.5 还款 4.7 其他 →