数字人民币报备查询API
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2023.04.13 | 初版 |
2、业务说明
（1）接口说明
报备结果查询
请求主体类型：application/json
请求方式：POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/report/digitalRmb/search |
| 正式环境 | https://ysgate.ysepay.com/openapi/report/digitalRmb/search |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称，固定值：report.digitalRmb.search |
| 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(30) | Y | 商户号 |
| reportChannel | String | Y | 报备渠道,类型如下: PSBC-邮储 ICBC-工商银行 CCB-建设银行 CIB-兴业银行 |
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数据)
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| businessData | Object | N | 业务数据 |
| reqMsgId | String | N | 请求流水号 |
5.2.1 businessData具体参数
| 参数 | 类型(长度） | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | Y | 商户号 |
| orgNo | String | Y | 所属机构 |
| businessTypeCode | String | Y | 业务类型编码 |
| businessClassCode | String | Y | 业务种类编码 |
| accBankNo | String | Y | 钱包ID |
| accName | String | Y | 钱包名称 |
| reportChannel | String | Y | 报备渠道,银行英文名称。 PSBC-邮储 ICBC-工商银行 CCB-建设银行 CIB-兴业银行 |
| reportState | String | Y | 报备状态,类型如下： 00-成功 99-失败 98-失败 80-中间状态 50-超时 |
| payGateNo | String | Y | 网关编号,编号如下： 建行-10520010 工行-10210010 邮储-4031000001 兴业银行-309000001 |
| payType | String | Y | 交易类型,工行提供，默认：113 |
| remark | String | Y | 备注 |
| note | String | Y | 渠道返回信息 |
| thirdMercId | String | N | 第三方商户号,渠道侧生成的商户号。 |
| createTime | String | Y | 资料录入时间,格式：yyyyMMddHHmmss。 |
| reportPerson | String | Y | 报备人 |
| reportTime | String | Y | 报备时间,格式：yyyyMMddHHmmss。 |
| settleAccountFlag | String | Y | 结算账号标志 |
| busiLongLati | String | Y | 经营地址经纬度 |
| terminalAddr | String | Y | 终端地址 |
| termLongLati | String | Y | 终端地址经纬度 |
| paySingleLimit | String | Y | 支付单笔限额值,单位：元。 |
| dayAmountLimit | String | Y | 日累计限额,单位：元。 |
| monthAmountLimit | String | Y | 月累计限额值,单位：元。 |
| mercMcc | String | Y | 商户类别码,参照人行标准字典，示例：5943。 |
| mercType | String | Y | 商户种类,类型如下： 01-上线商户 02-线下商户 |
| autoWalletFlag | String | Y | 自动开钱包时标识,1：自动开钱包，0：手动开钱包。 |
| walletId | String | Y | 钱包号 |
| walletType | String | Y | 钱包类型,类型如下： WT01-个人钱包 WT02-子个人钱包 WT09-对公钱包 WT10-子对公钱包 |
| walletName | String | Y | 钱包名称 |
| bankNo | String | Y | 开户机构编号 |
| settlePayAccountNo | String | Y | 结算支付账号 |
| settlePayAccountName | String | Y | 结算支付账户名称 |
| posId | String(9) | Y | 商户柜台代码 |
| branchId | String | Y | 分行代码 |
| terminalNo | String(19) | Y | 终端号 |
| clientIp | String | Y | ip地址 |
| recvMerId | String | Y | 共享收单商户编号 |
| qrUrl | String | Y | 商户收款码URL |
| mercSalType | String | Y | 商户优惠标志,标识如下： 00-普通商户（默认） 01-优惠类商户 02-减免商户 03-特殊计费商户 |
| mercBusinessType | String | Y | 结算规则id |
| txnCode | String | Y | 邮储交易类型,类型如下： 9001-数币动态码主扫-互联互通 9002-数币静态码主扫-直联 9003-数币被扫支付-互联互通 9004-数币被扫支付-直联 9005-碰一碰-互联互通 9006-碰一碰-直联 9007-数币协议支付-线下场景 9008-数币动态码主扫-直联 9009-双离线支付 |
| digitalAgreement | String | Y | 邮储数币协议 |
| channelRecvSn | String | Y | 渠道流水 |
| openChildWallet | String | Y | 是否开通硬钱包 |
| openChildWalletId | String | Y | 硬钱包id |
| jumpUrl | String | Y | 签约跳转地址 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 交易成功 | 请求成功，根据业务字段判断业务是否成功。 |
| 9999 | 系统错误 | 支付中该状态为未知状态，请勿当成失败状态处理，请等待支付 通知或继续查询 |
| 5000 | 请求超时 | 请调用查询接⼝查询订单状态 |
| A029998 | 网关非法参数 | 根据返回的描述，修改请求参数。 |