修订历史记录

版本号 日期 说明 作者
V0.1 2019/09/03 新接口参数定义 周鹏
V0.2 2020/04/14 报备及修改接口增加身份证、营业执照有效期信息及小微经营类型和小微门店名称信息 黄龙

请求地址

环境 HTTPS请求地址
正式环境 https://multiapi.ysepay.com:2443/busi-gate-api/mercScanReport

请求公共参数说明

请求参数是商户在与银盛支付进行数据交互时，提供给银盛支付的请求数据，以便银盛支付根据这些数据进一步处理。本文档中的所定义的接口，请求头部均要求按照此表格列出的参数给出。

参数 类型(字节长度） 参数说明 是否可为空 样例
method String(1,128) 接口名称。 必填 商户扫码报备接口：ysepay.merchant.scan.report。商户扫码活动开通接口：ysepay.merchant.scan.report.activity。商户扫码报备查询接口：ysepay.merchant.scan.report.query
partner_id String(1,20) 商户在银盛支付平台开设的用户号[商户号] 必填
timestamp String(1,19) 发送请求的时间，格式"yyyy-MM-dd HH:mm:ss" 必填 2014-07-24 03:07:50
charset String(1,10) 商户网站使用的编码格式，如utf-8、gbk、gb2312等。 必填 GBK
sign_type String(1,10) 签名类型，RSA/SM 必填 SM
sign String(1,256) 进行Base64编码后的签名字符串 必填
notify_url String(190) 银盛支付服务器主动通知商户网站里指定的页面http路径。 必填 http://api.test.ysepay.net/atinterface/receive_return.htm
version String(1,3) 接口版本 必填 3.0
biz_content String 业务请求参数的集合，最大长度不限，除公共参数外所有请求参数都必须放在这个参数中传递 必填

请求业务参数说明

参数名biz_content,值为一个json格式对象，下面列表描述json对象的值

商户扫码报备接口

该接口如果之前已经报备成功继续调用该接口，则会返回报备成功，如果资料跟报备成功时不一致系统并不会进行修改

商户扫码报备接口参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
mercId String(20) 商户号 必填 “826440352618039”
reportChannel String(20) 渠道编号。NUCC_WECHAT微信支付（网联）；CUPS_WECHAT 微信支付（银联总部）；CUPS_ALIPAY 支付宝（银联总部）；NUCC_ALIPAY 支付宝（网联） 必填 “NUCC_WECHAT”
mccSubCd String(8) 银盛商户类型 非必填
mercAbbr String(16) 商户简称 非必填 “银盛支付”
mercName String(64) 商户名称 非必填 “银盛支付”
mercProv String(4) 商户归属省 必填 广东省
mercCity String(4) 商户归属市 必填 深圳市
mercArea String(4) 商户归属区 必填 南山区
busAddr String(64) 营业地址（联系地址） 非必填 “广东深圳市南山区”
contactsName String(16) 商户联系人姓名 必填 “陈某玲”
contactsTel String(11) 商户联系人手机 必填 “130123456789”
contactsEmail String(64) 商户联系人邮箱 非必填 “130123456789\@163.com”
crpNm String(30) 法人姓名 注：使用DES加密，密钥partner_id前8位，不足8位前补空， 国密签名方式使用公钥以国密方式加密 非必填 “陈某玲”
crpIdNo String(30) 法人证件号码 注：使用DES加密，密钥partner_id前8位，不足8位前补空， 国密签名方式使用公钥以国密方式加密 非必填 “520000199910120000”
businessLicense String(32) 营业执照号码 非必填
orgNo String(10) 商户归属机构 非必填 “0000100000”
mchType String(32) 商户类型 必填 “294”，参考3.6商户类型
bankName String(64) 开户行名称 非必填 “中国建设银行股份有限公司深圳海月支行”
accountType String(2) 银行账户类型。11:个人借记卡；12:个人贷记卡；13:个人存折；21:对公借记卡；22:对公贷记卡；23:对公存折；00:平台非必填账户 非必填 “11”
accountName String(64) 银行卡账户名 需和法人姓名或营业执照商户名称一致注：使用DES加密，密钥partner_id前8位，不足8位前补空， 国密签名方式使用公钥以国密方式加密 非必填 “陈某玲”
accountNo String(32) 银行账号 注：使用DES加密，密钥partner_id前8位，不足8位前补空， 国密签名方式使用公钥以国密方式加密 非必填 “6230947200005885008”
bankType String(15) 银行行别 非必填 建设银行
appletAppid String(32) 小程序APPID 微信参数 非必填
appid String(32) 公众号appid。微信参数如果授权可以使用银盛公众号则非必填 非必填
jsapiPath1 String(256) 公众号授权目录1。微信参数 非必填
jsapiPath2 String(256) 公众号授权目录2。微信参数 非必填
jsapiPath3 String(256) 公众号授权目录3。微信参数 非必填
jsapiPath4 String(256) 公众号授权目录4。微信参数 非必填
jsapiPath5 String(256) 公众号授权目录5。微信参数 非必填
pid String(32) 推荐关系PID。支付宝参数 非必填
idValidDateBegin String(8) 身份证有效开始期 必填 格式：yyyyMMdd。
idValidDateEnd String(8) 身份证有效结束期 必填 格式：yyyyMMdd。长期填入29991231
busLincenceBegin String(8) 营业执照有效开始期 非必填 格式：yyyyMMdd。开始期和结束期必须同时为空或不为空
busLincenceEnd String(8) 营业执照结束期 非必填 格式：yyyyMMdd。长期填入29991231
managementType String(2) 小微经营类型,00:门店场所,01:流动经营/便民服务,02:线上商品/服务交易 非必填 例：“00”。无营业执照时，报备的商户类型为小微时填入
storeName String(64) 小微门店名称 非必填 例：“大郎烧饼”。无营业执照时，报备的商户类型为小微时填入

服务器同步返回参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
respCode String 响应码 必填 参考3.8响应码列表
respMsg String 响应信息 必填
busiType String 业务类型:0-微信 1-支付宝 2-银盛通 4-QQ钱包 必填
channelId String 渠道编号 必填
thirdMercId String 第三方商户号 必填
apprSts String 报备状态：00-已注册（交易开通）01-待审核 02-审核中 03-注册失败 必填
remark String 备注 非必填 备注

商户活动报名接口

商户活动报名接口参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
mercId String(20) 商户号 必填 “826440352618039”
activityType String(1) 开通活动类型。1：支付宝；2:微信 必填 1

服务器同步返回参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
mercId String(20) 商户号 必填 “826440352618039”
busiType String 业务类型（微信、支付宝、银盛通）0-微信 1-支付宝 必填
channelId String 渠道编号 必填
activitiFlag String 1 蓝海 2 绿洲 必填
status String 活动状态 00 成功 01 待审核 其他 失败 必填
remark String 活动说明 必填
respCode String 响应码 必填 参考3.8响应码列表
respMsg String 响应信息 必填 成功

注：开通需要补齐相关图片（上传参照附件图片上传接口）

（1）蓝海行动需要上传图片类型：34、门店门头照；42、门店内景照；55、主流平台入驻照片；19、营业执照；52、收银台图片

（2）绿洲计划需要上传图片类型：34、门店门头照；42、门店内景照；54、平台入驻照片微信；19、营业执照；52、收银台图片；51、BD与门头照合影；53、BD与门店摇摇乐海报合影

（3）取消参加活动请调用修改接口，变更对应活动的状态

商户扫码报备查询接口

商户扫码报备查询接口参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
mercId String(20) 商户号 必填 “826440352618039”
channelId String(20) 渠道编号 必填 “NUCC_WECHAT”

服务器同步返回参数说明

参数 类型(字节长度） 参数说明 是否可为空 样例
mercId String(20) 商户号 必填
channelId String(20) 渠道编号 必填
apprSts String(2) 报备状态00-已注册（交易开通）01-待审核 02-审核中 03-注册失败 04-交易关闭 99-" " 必填
thirdMercId String(32) 第三方商户号 必填
remark String 活动说明 必填
respCode String 响应码 必填 参考3.8响应码列表
respMsg String 响应信息 必填 成功

商户类型

类型 描述 支付宝 微信 微信个体或小微是否支持
100 实物 支持 支持
110 综合商城 支持 支持 不支持
111 超市（线下） 支持 不支持
121 服饰类商城/服饰配件/箱包 支持 支持
122 礼品/鲜花/纪念品 支持 支持
123 户外/运动/健身器材/安防 支持 支持
124 乐器 支持 支持
125 手表/钟表/眼睛（美瞳） 支持 支持
126 黄金珠宝/钻石/玉石 支持 支持 不支持
127 首饰/饰品 支持 支持 不支持
128 装饰/设计 支持
131 家居/建材/装饰/布艺类商城 支持 支持
132 食品 支持 支持
133 保健品/滋补品 支持 支持
134 家用电器 支持 支持
135 成人计生用品 支持 支持
136 美妆/护肤/个人护理 支持 支持
137 工艺品/盆栽/室内装饰品 支持 支持
138 汽车/摩托/自行车/配件/改装 支持 支持
139 餐饮 支持 支持
141 数码产品 支持 支持
142 办公设备（打印机/复印机/扫描仪等） 支持 支持
150 母婴/玩具 支持 支持
154 培训教育 支持 支持
155 医药 支持 支持
156 摄影 支持 支持
161 影票/演唱会/赛事等娱乐票务 支持 支持
162 火车票/船票/车票等长途交通票务 支持 支持
170 票务/机票/旅游 支持 支持 不支持
171 旅行社 支持 支持 不支持
172 旅游服务平台 支持 支持 不支持
173 交通运输服务类 支持 支持
175 旅馆/酒店/景区/度假区 支持 支持
180 书籍/音像/文具 支持 支持
190 收藏/宠物/文物/非文物 支持 支持 不支持
210 彩票 支持 支持
220 生活/咨询服务 支持 支持 不支持
221 人才中介机构/招聘/猎头 支持 支持
222 婚庆/婚介 支持 支持
223 网上生活服务平台 支持 支持 不支持
230 金融 支持 支持
240 保险/保险公司 支持 支持 不支持
250 公益 支持 支持
260 网络虚拟服务/软件/彩铃 支持 支持 不支持
263 机械设备/电子 支持 支持
265 通信/宽带/话费充值 支持 支持
280 娱乐/健身服务 支持 支持
290 苗木/绿化/化肥 支持 支持
291 快递/货运服务 支持 支持
292 水电煤缴费/交通罚款等生活缴费 支持 支持 不支持
293 公立医院 支持 支持 不支持
294 民办院校（中学/小学/幼儿园） 支持 支持 不支持
295 挂号平台 支持 支持 不支持
296 公立院校 支持 不支持
297 停车缴费 支持 不支持
298 事业单位 支持 不支持
299 物业管理费 支持 不支持
300 其他生活缴费 支持
301 教育/培训/考试缴费/学费 支持
302 私立院校 支持
303 诊所/卫生站/卫生服务中心 支持
304 咨询/法律咨询/金融咨询等 支持
305 宗教 支持
310 [个体户]美妆/护肤/个人护理 支持 支持

证件类别

类型 描述 类型 描述
00 公民身份证正面 12 军事院校学员证
01 中国护照 13 武装警察身份证
02 军人身份证 14 军官证
03 警官证 15 文职干部证
04 户口簿 16 军人士兵证
05 临时身份证 17 武警士兵证
06 外国护照 18 其他证件
07 港澳通行证 19 营业执照
08 台胞通行证 20 税务登记证
09 离休干部荣誉证 30 公民身份证反面
10 军官退休证 31 客户协议
11 文职干部退休证 32 授权书

3.8 响应码列表

类型 描述
00 成功
01 提交成功，待审核
08 无效金额
10 报文格式错误
13 报文要素缺失
50 系统繁忙，请稍后重试
99 系统错误，注册失败

附件：图片上传接口

图片上传接口参数说明

请求地址为：

https://uploadApi.ysepay.com:2443/yspay-upload-service?method=reportImageUpload

参数 类型(字节长度） 参数说明 是否为空 样例
picType String(1,2) 图片类型 不可空 参考3.8
picFile 通过body的mutipartfile类型上传 不可空
token String(1,50) token值 不可空 获取token的请求地址为https://register.ysepay.com:2443/register_gateway/gateway.do。公共请求参数的method为:ysepay.merchant.register.token.get。该接口参数请求为空（但是biz_content依然要求按照json格式填写）
mercId String(20) 商户号 不可空 Ys

图片文件的类型以及说明

类型 描述
00 公民身份证正面
19 营业执照
20 税务登记证
30 公民身份证反面
31 客户协议
32 授权书
33 手持身份证正扫面照
34 门头照
35 结算银行卡正面照
36 结算银行卡反面照
37 开户许可证或印鉴卡
41 门店外景照
42 门店内景照
43 门店收银台照
51 BD与门头照合影
52 收银台图片
53 BD与门店摇摇乐海报合影
54 平台入驻照片微信
55 主流平台入驻照片

{"code":200,"message":"成功","data":null,"list":null}{"code":200,"message":"成功","data":null,"list":null}{"code":200,"message":"成功","data":null,"list":null}{"code":200,"message":"成功","data":null,"list":null}{"code":200,"message":"成功","data":null,"list":null}

results matching ""

    No results matching ""