修改报备信息
1、修订记录
| 修订记录 | 日期 | 说明 |
|---|---|---|
| 1.0 | 2022.10.20 | 初版 |
2、业务说明
(1)接口说明
修改报备信息
请求主体类型:application/json
请求方式:POST
3、请求地址
| 环境 | HTTPS请求地址 |
|---|---|
| 测试环境 | https://appdev.ysepay.com/openapi/report/scan/union/unionReportUpdate |
| 正式环境 | https://ysgate.ysepay.com/openapi/report/scan/union/unionReportUpdate |
4、请求参数说明
4.1、公共请求参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
| method | String(128) | Y | 接口名称,固定值:report.scan.union.unionReportUpdate |
| 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数据明文字符串)
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| channelId | String(20) | Y | 交易报备渠道编号,CUPS_WECHAT-银联微信;CUPS_ALIPAY-银联支付宝;NUCC_WECHAT-网联微信;NUCC_ALIPAY-网联支付宝 |
| mercId | String(20) | Y | 商户号 |
| busiType | String(1) | Y | 业务类型,0-表示微信商户;1-表示支付宝商户 |
| flag | String(8) | Y | 修改或修改并报备标识,UPDATE、REPORT |
| mercName | String(50) | N | 商户名称 |
| thirdMercIdThree | String(1) | N | 特殊费率,1-互联网费率;2-保险费率;3-线下费率;4-公开事业费率;5;零费率;6-行业活动;8-民办中小幼费率 |
| mercType | String(1) | N | 商户信息-商户类别,0或null:普通商户,1:小微商户,2:个体商户,3:事业单位,4:社会组织(原其他组织), 5:政府机关 |
| provName | String(6) | N | 归属省 |
| cityName | String(6) | N | 归属市 |
| area | String(6) | N | 归属区 |
| busAddr | String(255) | N | 商户地址 |
| mchType | String(3) | N | 商户信息-商户类型,传编码,详见"商户类型"。 |
| pid | String | N | 支付宝推荐关系pid |
| mercShortName | String(50) | N | 商户简称 |
| hotLine | String(20) | N | 客服电话 |
| crpIdTyp | String(2) | N | 法人证件类型,00-身份证 01-中国护照 02-军人身份证 03-警官证 04-户口簿 05-临时身份证 06-外国护照 07-外国护照 08-台胞通行证 09-离休干部荣誉证书 10-军官退休证书 11-文职干部退休证书 12-军事院校哦学员证书 13-武装警察身份证 14-军官证 15-文职干部证书 16-军人士兵证书 17-武警士兵证书 18-其他证件 |
| crpNm | String(50) | N | 法人姓名 |
| busidNo | String(50) | N | 法人证件号码 |
| socialCreditCodeValid | String(4) | N | 法人身份证有效期,填数字,10 表示10年 |
| idValidDateBegin | String(8) | N | 法人身份证开始有效期,yyyyMMdd格式 |
| idValidDateEnd | String(8) | N | 法人身份证结束有效期,yyyyMMdd格式,如果为永久值,则为29991231 |
| contactCorpId | String(50) | N | 联系人证件号码 |
| contactName | String(50) | N | 联系人姓名 |
| phone | String(11) | N | 联系人电话 |
| String(50) | N | 联系人邮箱 | |
| busLicenseBegin | String(8) | N | 营业执照有效开始期,yyyyMMdd格式 |
| busLicenseEnd | String(8) | N | 营业执照有效结束期,yyyyMMdd格式,如果为永久值,则为29991231 |
| unitPhoto | String(100) | N | 单位证明函, 当picType=1时,传图片ID(调用图片上传接口得到图片ID); 当picType=2时,传url地址,例如:group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg |
| bookType | String(22) | N | 证书类型,CERTIFICATE_TYPE_2388:事业单位法人证书,CERTIFICATE_TYPE_2389:统一社会信用代码证书,CERTIFICATE_TYPE_2390:有偿服务许可证(军队医院适用),CERTIFICATE_TYPE_2391:医疗机构执业许可证(军队医院适用),CERTIFICATE_TYPE_2392:企业营业执照(挂靠企业的党组织适用),CERTIFICATE_TYPE_2393:组织机构代码证(政府机关适用),CERTIFICATE_TYPE_2394:社会团体法人登记证书,CERTIFICATE_TYPE_2395:民办非企业单位登记证书,CERTIFICATE_TYPE_2396:基金会法人登记证书,CERTIFICATE_TYPE_2397:慈善组织公开募捐资格证书,CERTIFICATE_TYPE_2398:农民专业合作社法人营业执照,CERTIFICATE_TYPE_2399:宗教活动场所登记证,CERTIFICATE_TYPE_2400:其他证书/批文/证明 |
| businessLicense | String(50) | N | 证件编号 |
| businessLicenseType | String(1) | N | 证照类型,0:营业执照;1:事业单位法人证书;2:小微商户负责人身份证;3:社会信用等级证书。为空或传其他值小微默认为2,其他默认为3。 |
| activateStatus | String(2) | N | 商户状态,默认:00 00:启用; 01:注销; 当flag=UPDATE时,activateStatus传01才有效。 注意:如果商户被注销,则无法交易 |
| checkStandPhoto | String(100) | N | 收银台图片, 当picType=1时,传图片ID(调用图片上传接口得到图片ID); 当picType=2时,传url地址,例如:group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg |
| applyServices | String(2) | N | 商户信息-商户信息-申请的服务,01:正扫&反扫;02:JS支付 (包括公众号/生活号,A/T的小程序支付)。如有多个,必须用英文分号“;”隔开 |
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 | 交易状态 错误码成功时响应 |
| terminalInfoList | Object | N | 终端报备结果 |
| thirdMercId | String | N | 第三方商户号 |
5.2.1 terminalInfoList具体参数
| 参数 | 类型(长度) | 必填 | 参数说明 |
|---|---|---|---|
| mercId | String | N | 商户号 |
| channelCode | String | N | 终端报备渠道编号 |
| terminalType | String | N | 终端类型,01 自动柜员机(含 ATM 和 CDM)和多媒体自助终端、02 传统 POS、03 mPOS、04 智能 POS、05 II 型固定电话、 06 云闪付终端、07 保留使用、08 手机 POS、09 刷脸付终端、10 条码支付受理终端、11 辅助受理终端、12 行业终端(公交、地铁用于指定行业的终端)、13 MIS 终端 |
| terminalNo | String | N | 终端编号 |
| serialNum | String | N | 终端序列号 |
| terminalAddr | String | N | 终端布放地址 |
| terminalReportState | String | N | 终端报备状态,00-成功;99-失败。 |
| note | String | N | 终端报备说明 |
6、业务响应码 网关公共响应码
| 响应码 | 响应码描述 | 解决方案 |
|---|---|---|
| 0000 | 成功 | |
| 9999 | 失败 | 系统异常,请稍后使用相同的参数继续调用 |
| 5000 | 超时 | 业务系统超时,请稍后使用相同的参数继续调用 |
| A029998 | 参数非法 | 请根据接口返回的详细信息检查请求参数 |