新增报备信息

1、修订记录

修订记录 日期 说明
1.0 2023.04.23 初版

2、业务说明

（1）接口说明

新增报备信息

请求主体类型：application/json

请求方式：POST

3、请求地址

环境 HTTPS请求地址
测试环境 https://appdev.ysepay.com/openapi/report/scan/union/reportAdd
正式环境 https://ysgate.ysepay.com/openapi/report/scan/union/reportAdd

4、请求参数说明

4.1、公共请求参数

参数 类型(长度） 必填 参数说明
timeStamp String Y 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss"
method String(128) Y 接口名称，固定值：report.scan.union.reportAdd
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数据明文字符串）

参数 类型(长度） 必填 参数说明
channelCode String(20) Y 交易报备渠道编号,类型如下：
CUPS_WECHAT-银联微信
CUPS_ALIPAY-银联支付宝
NUCC_WECHAT-网联微信
NUCC_ALIPAY-网联支付宝
mercId String(20) Y 商户信息-商户号
linencePhoto String(100) N 商户信息-营业执照营业执照复印件(盖公章),
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
小微实名认证必填；微信新绿洲计划报备必填；蓝海行动报名必填
indentityPhoto String(100) N 商户信息-法人身份证复印件（盖私章，签字）/原件扫描件,商户进件时未传，法人身份证复印件（盖私章，签字）/原件扫描件必传；
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
protocolPhoto String(100) N 商户信息-服务协议复印件（盖公章）/原件扫描件,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
cocc String(100) N 商户信息-组织机构代码证（盖公章）/原件扫描件,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
蓝海行动报名必填
sfzFrontPhoto String(100) N 商户信息-法人身份证正面照,商户进件时未传，法人身份证正面照必传；
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
sfzBackPhoto String(100) N 商户信息-法人身份证反面照,商户进件时未传，法人身份证反面照必传；
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
idcarNo String(50) N 商户信息法人身份证号码
mccSubCd String Y 商户信息-银盛商户类型,传商户类型编码，详见"银盛商户类型及mcc码对照表"。
busiType String(1) Y 业务类型,类型如下：
0-微信 
1-支付宝
mercShortName String(50) Y 商户信息-商户简称
mercProv String(6) Y 商户信息-商户归属省,所属省编码，例:5800。通过"地区信息查询"接口获取cityCd，详见地区信息查询
mercCity String(6) Y 商户信息-商户归属市,所属市编， 例:5840。通过"地区信息查询"接口获取cityCd，详见地区信息查询
mercArea String(6) Y 商户信息-商户归属区,所属区编码，例:5840。通过"地区信息查询"接口获取cityCd，详见地区信息查询
busAddr String(255) Y 商户信息-营业地址（联系地址）
contactsName String(50) Y 商户信息-商户联系人名称
contactsTel String(11) Y 商户信息-商户联系人手机
contactsEmail String(50) Y 商户信息-商户联系人邮箱
crpNm String(50) Y 商户信息-法人名称
orgNo String(20) Y 商户信息-商户归属机构
certNo String(50) Y 商户信息-法人证件号码
agentName String(50) N 商户信息-代理商名称
agtMercId String(20) N 商户信息-代理商编号
bankType String(20) Y 商户信息-开户行行别,通过"行名行号查询"获取bankCode，详见行名行号查询
bankName String(50) Y 商户信息-开户行名称
accountType String(2) Y 商户信息-账户类型,11-个人借记卡 12个人贷记卡 13个人存折 14对私借记卡（二类户） 21对公借记卡 22对公贷记卡 23对公存折 24单位结算卡 31有卡bin预付费卡 32无卡bin预付费卡 00平台账户 **所有卡类型
accountName String(50) Y 商户信息-账户名称
accountNo String(32) Y 商户信息-账户账号
custId String(20) Y 商户信息-客户号
mchType String(3) Y 商户信息-商户类型,传编码，详见"商户类型"。
mercName String(50) N 商户信息-商户名称
reportName String N 商户信息-微信报备名称
mercType String(1) Y 商户信息-商户类别,类别如下：
0或null-普通企业商户
1-小微商户
2-个体商户
3-事业单位
4-社会组织（原其他组织）
5-政府机关
certType String(2) N 商户信息-法人证件类型,类型如下：
00-身份证
01-中国护照
02-军人身份证
03-警官证
04-户口簿
05-临时身份证
06-外国护照
07-外国护照
08-台胞通行证
09-离休干部荣誉证书
10-军官退休证书
11-文职干部退休证书
12-军事院校哦学员证书
13-武装警察身份证
14-军官证
15-文职干部证书
16-军人士兵证书
17-武警士兵证书
18-其他证件
pId String N 商户信息-支付宝推荐关系pid
shopPhoto String(100) N 商户信息-门头照,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
小微实名认证必填；微信新绿洲计划报备必填；蓝海行动报名必填
storeEnvirPhoto String(100) N 商户信息-店内环境照,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
小微实名认证必填；微信新绿洲计划报备必填；蓝海行动报名必填
idImgHand String(100) N 商户信息-手持身份证照,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
小微实名认证必填
bankCardImg String(100) N 商户信息-银行卡照片或开户许可证,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
bdShopPhoto String(100) N 商户信息-客户经理与门头照合影,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
微信新绿洲计划报备必填
bdPosterPhoto String(100) N 商户信息-客户经理与门店摇摇乐海报合影,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
微信新绿洲计划报备必填
wxPlatform String(100) N 商户信息-平台入驻照片(微信),
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
微信新绿洲计划报备必填
idValidDateBegin String(8) N 商户信息-法人证件有效开始期,格式：yyyyMMdd
idValidDateEnd String(8) N 商户信息-法人证件有效结束期,格式：yyyyMMdd，如果为永久值，则为29991231。
busLincenceBegin String(8) N 商户信息-营业执照有效开始期,格式：yyyyMMdd
busLincenceEnd String(8) N 商户信息-营业执照失效期,格式：yyyyMMdd，如果为永久值，则为29991231。
managementType String N 商户信息-小微商户经营类型,类型如下：
00-门店场所
01-流动经营/便民服务
02-线上商品/服务交易
storeName String N 商户信息-门店名称
wechatCheckStandPhoto String(100) N 商户信息-微信收银台照片,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
微信新绿洲计划报备必填
alipayCheckStandPhoto String(100) N 商户信息-支付宝收银台主扫照片,
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
蓝海行动报名必填
aliPayStoreCashierPhoto 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：其他证书/批文/证明
unitPhoto String(100) N 商户信息-单位证明函,商户类别为事业单位时，单位证明函必传
当picType=1时，传图片ID(调用图片上传接口得到图片ID)；
当picType=2时，传url地址，例如：group1,M00/26/0D/CtUiIlYg-AcTmgAAU2krJ8NgE60.jpeg
hotLine String(20) N 商户信息-客服电话
businessLicenseType String(1) Y 商户信息-证照类型,类型如下：
0-营业执照
1-事业单位法人证书
2-小微商户负责人身份证
3-社会信用等级证书
businessLicense String(50) Y 商户信息-证件编号
appletAppId String N appid信息-小程序APPID
appId1 String N appid信息-公众号1
appId2 String N appid信息-公众号2
appId3 String N appid信息-公众号3
appId4 String N appid信息-公众号4
applyServices String(2) N 商户信息-申请的服务,如有多个，必须用英文分号“;”隔开。
类型如下：
01-正扫&反扫
02-JS支付 (包括公众号/生活号,A/T的小程序支付)。
picType String(1) N 上传图片类型,类型如下：
1-图片id
2-图片url
可为空，1或空时为图片id，识别url时必须传2
jsapiPath1 String N 公众号授权目录1
jsapiPath2 String N 公众号授权目录2
jsapiPath3 String N 公众号授权目录3
jsapiPath4 String N 公众号授权目录4
jsapiPath5 String N 公众号授权目录5

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(64) N 请求流水号
state String(2) N 交易状态 错误码成功时响应
mercId String(20) N 商户号
mchFlag String(1) N 商户标识,0.线下 1.线上
busiType String(1) N 业务类型,0-微信 1-支付宝 2-银盛通 4-QQ钱包
channelId String(20) N 交易报备渠道编号
bakModel String(1) N 报备模式,0:一户一报 1:大商户模式 默认0
thirdMercId String(32) N 三方商户号
thirdMercIdTwo String(32) N 第三方商户号
apprSts String(2) N 报备状态,00-已注册（交易开通）01-待审核 02-审核中 03-注册失败 04-交易关闭 99-失败
remark String(255) N 备注
key String N 秘钥
openId String N id号
creatDate String N 录入时间
reportDate String N 报备时间
mercType String(1) N 商户信息-商户类别,0或null：普通企业商户，1：小微商户,2：个体商户,3：事业单位，4：社会组织（原其他组织）， 5：政府机关
mchType String N 商户信息-报备行业类型
appId String N 公众号
appletAppId String N 程序公众号
thirdMercIdThree String N 微信一级行业类目
level String N 支付宝商户等级
terminalInfoList Array N 终端报备结果列表
appId1Flag String N 公众号1新增结果,true-成功；false-失败
appId2Flag String N 公众号2新增结果,true-成功；false-失败
appId3Flag String N 公众号3新增结果,true-成功；false-失败
appId4Flag String N 公众号4新增结果,true-成功；false-失败

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 参数非法 请根据接口返回的详细信息检查请求参数

results matching ""

    No results matching ""