邮储数字人民币报备API
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2023.04.13 | 初版 |
2、业务说明
(1)接口说明
邮储数字人民币-商户报备
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/report/digitalRmb/psbc |
正式环境 | https://ysgate.ysepay.com/openapi/report/digitalRmb/psbc |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:report.digitalRmb.psbc |
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 | 商户号 |
riskGradeInfo | String | Y | 风险评估数组,JSON字符串,示例:{"001":"01","002":"01","003":"01","004":"01","005":"01","006":"01","007":"01","008":"02","009":"01"}。 |
personalReportParam | Object | Y | 邮储报备个性化信息 |
4.2.1 personalReportParam具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
mercMcc | String(4) | Y | 商户类别码,通过"查询MCC码"接口获取mccCd,详见MCC码查询。 |
longitude | String(11) | Y | 经度,示例:116.40400。 |
latitude | String(11) | Y | 纬度,示例:39.92800。 |
mercProvinceCode | String(4) | Y | 商户所在省份码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,示例:2200。 |
mercCityCode | String(4) | Y | 商户所在城市码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,示例:2360。 |
mercAreaCode | String(4) | Y | 商户所在地区码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,示例:2366。 |
legalProvinceCode | String(4) | Y | 法人所在省份码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,示例:2200。 |
legalCityCode | String(4) | Y | 法人所在城市码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,示例:2360。 |
legalAreaCode | String(4) | Y | 法人所在地区码 |
certImg | String(100) | Y | 证书照片,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
digitalAgreement | String(100) | Y | 数币协议,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
busLincenceBegin | String(8) | N | 证照有效日期开始日期,格式:yyyyMMdd。 |
busLincenceEnd | String(8) | N | 证照有效日期结束日期,格式:yyyyMMdd。 |
sfzfrontphoto | String(100) | Y | 法人身份证前面照片,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
sfzbackphoto | String(100) | Y | 法人身份证背面照片,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
certBusScope | String(32) | N | 经营范围 |
storeIndoorImg | String(200) | Y | 店内照,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
storeOutsidePic | String(200) | Y | 店外照,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
extraImg | String(200) | N | 其他照,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
inspectPicImg | String(200) | N | 工商信息照片,格式:fastdfs ,通过接口"文件上传"接口获取业务返回参数中url,示例:group1,M00/09/BF/CtUiIl75uXyAbb28AAC_dz6DpPo529.pdf。 |
txnCode | String(10) | Y | 数币线下交易类型,类型如下: 9001-数币动态码主扫-互联互通 9002-数币静态码主扫-直联 9003-数币被扫支付-互联互通 9004-数币被扫支付-直联 9005-碰一碰-互联互通 9006-碰一碰-直联 9007-数币协议支付-线下场景 9008-数币动态码主扫-直联 9009-双离线支付 |
walletId | String(32) | Y | 钱包号 |
walletType | String(10) | Y | 钱包类型,类型如下: WT01-个人钱包 WT02-子个人钱包 WT09-对公钱包 WT10-子对公钱包 |
walletName | String(50) | Y | 钱包名称 |
openChildWallet | String(2) | N | 是否开通硬钱包,1 开通;0 不开通;为空,默认0 |
childWalletId | String(50) | N | 硬钱包id |
mercBusinessType | String(3) | N | 结算规则id,示例:758。 |
mercSalType | String(3) | N | 商户优惠类标志,类型如下: 00-普通商户(默认) 01-优惠类商户 02-减免商户 03-特殊计费商户 |
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 | 请求流水号 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 交易成功 | 请求成功,业务不一定成功,需要查询接口查询结果。 |
9999 | 系统错误 | 支付中该状态为未知状态,请勿当成失败状态处理,请等待支付 通知或继续查询 |
5000 | 请求超时 | 请调用查询接⼝查询订单状态 |
0001 | 受理成功 | 邮储报备需人工审核,请调用数币商户报备查询接口,查询最终报备结果。 |
A029998 | 网关非法参数 | 根据返回的描述,修改请求参数。 |
B022011 | {字段中文名}信息为空 | 完善商户信息。 |
B022012 | 发起方商户号和商户号的归属关系校验失败 | 检查商户号是否为该发起方商户号下的商户。 |