签约状态查询
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2022.07.19 | 初版 |
1.1 | 2023.09.22 | 新增入参跟响应参数: thirdAuthId(业务方权限id) |
2、业务说明
(1)接口说明
使用场景: 合同签约申请接口后,会返回权限流水号authId,此接口通过authId查询签约状态,包含纸质合同和电子合同
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/smsc/saas/constract/queryAuthInfo |
正式环境 | https://ysgate.ysepay.com/openapi/smsc/saas/constract/queryAuthInfo |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:smsc.saas.constract.queryAuthInfo |
charset | String(10) | Y | 请求使用的编码格式,如utf-8,gbk,gb2312等,固定为utf-8 |
sign | String | Y | 商户请求参数的签名串(签名算法默认为国密),详见demo,注意:请用商户私钥进行签名 |
check | String | Y | 银盛公钥加密随机生成的字符串(key)得到的加密值,详见demo |
bizContent | String | Y | 业务参数的集合,最大长度不限,除公共参数外所有请求参数都必须放在这个参数中传递。注意:需要通过AES以及随机生成的字符串(key)加密业务参数集合,得到bizContent |
reqId | String | Y | 请求唯一流水号,商户系统唯一,要求32个字符内(最少14个字符),只能是数字、大小写字母_-且在同一个商户号下唯一。最后12位要求格式为"yyMMddHHmmss" 示例值:xy1415220315145602 |
certId | String | Y | 发起方商户号,服务商在银盛给自己开设的商户号,即可当作发起方商户号,由银盛生成并下发。 注意:不同于子商户号,服务商发展的商户即为子商户号 |
version | String | Y | 调用的接口版本,固定为:1.1 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
authId | String(32) | N | 权限流水号 |
thirdAuthId | String(32) | N | 业务方权限id,(若合同签约申请接口有上送此 字段,则可通过此字段查询签约状态信息) |
5、响应参数说明
请注意:银盛后期会对返回参数保留扩展的权力,扩展方式为新增参数但不会删除参数,请商户在解析银盛返回参数时要支持银盛可能扩展参数这种情况。5.1、公共响应参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
code | String(5) | Y | 网关响应码,示例值:00000 ,详见网关公共响应码 |
msg | String(50) | Y | 网关响应码描述 |
subCode | String | Y | 业务响应码,参见具体的API接口文档 |
subMsg | String | Y | 业务响应描述 |
timeStamp | String | Y | 响应时间,格式"yyyy-MM-dd HH:mm:ss" |
norce | String(128) | Y | 随机参数 |
sign | String | Y | 响应参数的签名串,详见demo, 注意:请用银盛公钥进行验签 |
businessData | String | Y | 业务响应参数集合, 注意:银盛网关通过AES加密业务响应参数集合,得到businessData,商户需要对其进行解密,详情请见demo |
5.2、业务响应参数
响应业务参数businessData(json数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
mercId | String(20) | N | 商户号,成功时才有值 |
authId | String(32) | N | 权限流水号 |
status | String(2) | N | 状态,00-成功、01-初始化、02-签约中(电子合同才会出现此状态)、03-待审核(纸质合同或发起方不支持自动审核会出现此状态)、04-审核拒绝。 |
signId | String(20) | N | 签约流水号,电子合同才有值 |
note | String(400) | N | 备注,审核拒绝才有值 |
thirdAuthId | String(32) | N | 业务方权限id |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 成功 | |
B519999 | 系统异常 | 请联系银盛技术人员处理 |
B519998 | 请勿频繁调用 | 请勿短时间内频繁请求 |
A519997 | 重复的请求 | 检查请求参数,修改后重新发起请求 |
A519996 | 非法金额 | 检查请求参数,修改后重新发起请求 |
A519990 | 请求参数非法 | 请根据返回提示操作 |
A550019 | 发起方不存在 | 检查请求参数,修改后重新发起请求或联系银盛技术人员处理 |
B550008 | 商户签约信息已丢失 | 检查请求参数,修改后重新发起请求或联系银盛技术人员处理 |
A510009 | 数据不存在 | 检查请求参数,修改后重新发起请求 |
A510001 | 发起方有误 | 检查请求参数,修改后重新发起请求或联系银盛技术人员处理 |
B519994 | 暂停服务 | 尊敬的云商服用户,您好!从即日起,云商服的服务时间调整为每日7时至20时59分,其余时段(当日21:00~次日06:59)暂停服务,敬请谅解 |