查询报备信息
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.06.07 | 初稿 |
2、业务说明
(1)接口说明
查询报备信息
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/report/scan/union/repAndAppIdQry |
| 正式环境 | https://ysgate.ysepay.com/openapi/report/scan/union/repAndAppIdQry |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:report.scan.union.repAndAppIdQry |
| 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.0 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | Y | 商户号 |
| channelId | String | Y | 交易报备渠道编号,CUPS_WECHAT-银联微信;CUPS_ALIPAY-银联支付宝;NUCC_WECHAT-网联微信;NUCC_ALIPAY-网联支付宝 |
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数据)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| reqMsgId | String | N | 请求流水号 |
| state | String | N | 交易状态 |
| mercId | String | N | 商户号 |
| mercType | String | N | 商户信息-商户类别,0或null:普通商户,1:小微商户,2:个体商户,3:事业单位,4:社会组织(原其他组织), 5:政府机关 |
| openId | String | N | 微信openid |
| remark | String | N | 备注 |
| creatDate | String | N | 录入时间 |
| appIdType | String | N | 公众号类型 |
| reportDate | String | N | 报备时间 |
| appId | String | N | 公众号 |
| busiType | String | N | 业务类型,0-微信 1-支付宝 2-银盛通 4-QQ钱包 |
| channelId | String | N | 交易报备渠道编号 |
| thirdMercId | String | N | 第三方商户号 |
| thirdMercIdTwo | String | N | 第三方商户号2,银联或网联通道时,表示收单机构的商户号. 银联支付宝的appid |
| appidType1 | String | N | appid1类型 |
| appidType2 | String | N | appid2类型 |
| appidType3 | String | N | appid3类型 |
| appidType4 | String | N | appid4类型 |
| appId1 | String | N | 公众号1 |
| appId2 | String | N | 公众号2 |
| appId3 | String | N | 公众号3 |
| appId4 | String | N | 公众号4 |
| mchType | String | N | 报备行业类型 |
| apprSts | String | N | 报备状态,00-已注册(交易开通)01-待审核 02-审核中 03-注册失败 04-交易关闭 |
| jsapiPath1 | String | N | 公众号授权目录1 |
| jsapiPath2 | String | N | 公众号授权目录2 |
| jsapiPath3 | String | N | 公众号授权目录3 |
| jsapiPath4 | String | N | 公众号授权目录4 |
| jsapiPath5 | String | N | 公众号授权目录5 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常,请稍后使用相同的参数继续调用 |
| 5000 | 超时 | 业务系统超时,请稍后使用相同的参数继续调用 |
| A029998 | 参数非法 | 请根据接口返回的详细信息检查请求参数 |