资料上送
1、修订记录
修订记录 | 日期 | 说明 |
---|---|---|
1.0 | 2022.08.09 | 初版 |
1.1 | 2023.04.21 | 结算信息stlAccInfo节点下新增以下参数: 1、备用结算账户类型-standByStlAccType 2、备用结算账号-standByStlAccNo 3、备用结算户名-standByStlAccNm 4、备用结算账户开户行支行编号-standByBankSubCode 5、备用结算账户银行开户行省代码-standByBankProvince 6、备用结算账户银行开户行市代码-standByBankCity |
1.2 | 2023.09.22 | 新增业务方入网申请流水号: thirdFlowId,更新mercName、mercShortName、busNm描述 |
2、业务说明
(1)接口说明
扫码服务商使用该接口提交商家(子商户)资料,帮助商家入驻成为银盛支付商户
请求主体类型:application/json
请求方式:POST
3、请求地址
环境 | HTTPS请求地址 |
---|---|
测试环境 | https://appdev.ysepay.com/openapi/t1/smsc/addCustInfoApply |
正式环境 | https://ysgate.ysepay.com/openapi/t1/smsc/addCustInfoApply |
4、请求参数说明
4.1、公共请求参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
timeStamp | String | Y | 发送请求的时间,格式"yyyy-MM-dd HH:mm:ss" |
method | String(128) | Y | 接口名称,固定值:t1.smsc.addCustInfoApply |
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.2 |
4.2、业务请求参数
(bizContent加密前的json数据明文字符串)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
custInfo | Object | Y | 基本信息 |
crpInfo | Object | Y | 法人信息 |
stlAccInfo | Object | Y | 结算信息 |
busInfo | Object | Y | 营业信息 |
thirdFlowId | String(32) | N | 业务方入网申请流水号,唯一(商户状态 查询接口可通过此字段查询) |
4.2.1 custInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
agtMercId | String(15) | N | 代理商编号,默认同发起方代理商编号,注意:需要上传子商户代理商编号(801开头),否则商户无法交易 |
mercName | String(100) | Y | 商户名称,(小微商户名称增加城市名称的校验,有门头(招牌),命名规则为“城市+门头名称”,无门头(招牌),命名规则为“城市 +法人姓名+主营”,其中城市录入规范为,如果是区的,就选地级市名称,如果是县市的选县市名称,也可以支持地级市或者县市名 称。 或者直接全部上送地市级名称) |
mercShortName | String(20) | Y | 商户简称,默认为商户名称(小微商户名称增加城市名称的校验,有门头(招牌),命名 规则为“城市+门头名称”,无门头(招牌), 命名规则为“城市+法人姓名+主营”,其中城市录入规范为,如果是区的,就选地级市名称,如果是县市的选县市名称,也可以支持 地级市或者县市名称。 或者直接全部上送地 市级名称) |
mercType | String(2) | Y | 商户类型,2 小微 3个体 4企业 5 社会组织 6 事业单位 7 政府机关 |
mccCd | String(4) | Y | mcc码,通过"查询MCC码"接口获取mccCd,详见MCC码查询 |
contactMail | String(50) | Y | 联系人邮箱 |
contactMan | String(20) | N | 联系人,默认同法人 |
contactPhone | String(11) | N | 联系人电话, 默认同法人电话号码 |
cusMgrNm | String(20) | Y | 客户经理 |
isOpenMarket | String(1) | N | 是否开通营销,Y开通N不开通,默认不开通 |
notifyUrl | String(100) | Y | 异步通知地址,银盛通过商户提供的地址下发通知,商户可根据异步通知业务参数bizContent中的notifyType确定通知类型,具体通知内容、场景以及接口要求详见如下: 客户进件异步通知(notifyType = 1) 合同签约异步通知(notifyType = 2) 入网资料变更通知(notifyType = 3) 费率变更异步通知(notifyType = 5) 报备异步通知(notifyType = 6) |
remark | String(200) | N | 备注 |
4.2.2 crpInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
crpCertNo | String(30) | Y | 法人证件号 |
crpCertType | String(2) | Y | 法人证件类型,00:身份证 06:国外护照 07:港澳通行证 08:台胞通行证 |
certBgn | String(8) | Y | 证件开始日期,证件开始日期yyyyMMdd |
certExpire | String(8) | Y | 证件有效期,日期格式yyyyMMdd ,如果为长期或者永久,请填值“29991231” |
crpNati | String(3) | N | 法人国籍,法人国籍(默认中国(249)) |
crpNm | String(20) | Y | 法人姓名 |
crpPhone | String(11) | Y | 法人手机号 |
crpAddr | String(100) | N | 法人地址 |
actContrInfo | Object | N | 实际控制人,默认同法人信息,若传值,则姓名,证件类型,证件号,证件开始日期、结束日期必填 |
authInfo | Object | N | 被授权人信息,法人结算同法人信息,非法人结算同开户人信息,若传值,则姓名,证件类型,证件号,证件开始日期、结束日期必填 |
bnfList | Array | N | 受益人,默认同法人,最多三个受益人 |
4.2.2.1 actContrInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
name | String(50) | N | 实际控制人姓名 |
certType | String(2) | N | 实际控制人证件类型 |
certNo | String(50) | N | 实际控制人证件号 |
certBgn | String(8) | N | 实际控制人证件起始日期,格式:YYYYMMDD |
certExpire | String(8) | N | 实际控制人证件有效期,格式:YYYYMMDD |
addr | String(100) | N | 实际控制人证件地址 |
4.2.2.2 authInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
name | String(50) | N | 被授权姓名 |
certType | String(2) | N | 被授权证件类型,暂时只支持 00 身份证 |
certNo | String(50) | N | 被授权人证件号 |
certBgn | String(8) | N | 被授权人证件开始日期,格式:YYYYMMDD |
certExpire | String(8) | N | 被授权人证件有效期,格式:YYYYMMDD |
addr | String(100) | N | 被授权人证件地址 |
4.2.2.3 bnfList具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
name | String(50) | N | 受益人姓名 |
certType | String(2) | N | 受益人证件类型,暂时只支持 00 身份证 |
certNo | String(50) | N | 受益人证件号 |
certBgn | String(8) | N | 受益人开始日期,格式:YYYYMMDD |
certExpire | String(8) | N | 受益人证件有效期,格式:YYYYMMDD |
addr | String(100) | N | 受益人地址 |
4.2.3 stlAccInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
isSettInPlatAcc | String(1) | N | 是否平台内账户,Y是 N否,默认否 |
isUncrpSett | String(1) | N | 是否非同名结算,Y:非同名结算(备用结算账户信息必传) N:同名结算,默认 N:同名结算 同名结算 1.小微商户:对私且结算账户名为法人姓名 2.个体商户: (1). 对私且结算账户名为法人姓名 (2). 对公且结算账户名为营业执照名 3.企业类商户: 对公结算 非同名结算 1.小微商户:不支持 2.个体商户:对私且结算账户名与法人姓名不相同 3.企业类商户: 对私结算 |
stlAccNm | String(20) | N | 结算户名,默认法人姓名, 非同名结算必填 |
stlAccNo | String(30) | Y | 结算账号 |
bankSubCode | String(20) | Y | 开户支行联行号,通过"行名行号查询"获取bankCode,详见行名行号查询 |
stlAccType | String(2) | Y | 结算账户类型,11 对私 21 对公 23 对公存折 24 单位结算卡 |
bankMobile | String(11) | N | 银行预留手机号,非同名结算必填 |
openCertNo | String(20) | N | 开开户证件号,默认法人证件号,非同名结算必填 |
bankProince | String | N | 银行开户行所属省代码,银行开户行所属市代码都填或都不填 详见地区信息查询 |
bankCity | String | N | 银行开户行所属市代码,银行开户行所属省代码都填或都不填 详见地区信息查询 |
standByStlAccType | String(2) | N | 备用结算账户类型,11 对私 21 对公 23 对公存折 24 单位结算卡 (isUncrpSett=Y时必传,备用结算账号账户相关信息如需上传则需完整上传整体相关信息) |
standByStlAccNo | String(30) | N | 备用结算账号,isUncrpSett=Y时必传 |
standByStlAccNm | String(20) | N | 备用结算户名,isUncrpSett=Y时必传 |
standByBankSubCode | String(20) | N | 备用结算账户开户行支行编号,isUncrpSett=Y时必传 |
standByBankProvince | String(10) | N | 备用结算账户银行开户行省代码,备用结算账户银行开户行市代码都填或都不填 (isUncrpSett=Y时必传) 详见地区信息查询 |
standByBankCity | String(10) | N | 备用结算账户银行开户行市代码,备用结算账户银行开户行省代码都填或都不填(isUncrpSett=Y时必传) 详见地区信息查询 |
4.2.4 busInfo具体参数
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
busNo | String(50) | N | 营业执照号,非小微必填 |
busNm | String(50) | Y | 营业执照名称,/商户名称(小微商户名称增加城市名称的校验,有门头(招牌),命名 规则为“城市+门头名称”,无门头(招牌), 命名规则为“城市+法人姓名+主营”,其中城市录入规范为,如果是区的,就选地级市名称,如果是县市的选县市名称,也可以支持地级市或者县市名称。 或者直接全部上送地市级名称) |
busCertBgn | String(8) | N | 营业执照有效开始日期,非小微必填 格式为yyyyMMdd |
busCertExpire | String(8) | N | 营业执照有效期,非小微必填 格式为yyyyMMdd |
busProviceCode | String(4) | Y | 营业归属省代码,通过"地区信息查询"接口获取cityCd,详见地区信息查询 |
busCityCode | String(4) | Y | 营业归属市代码,通过"地区信息查询"接口获取cityCd,详见地区信息查询 |
busAreaCode | String(4) | N | 营业归属区(县)代码,通过"地区信息查询"接口获取cityCd,详见地区信息查询,城市下有区(县必填),城市下无区(县)则不上送,如广东省中山市,广东省东莞市 |
busCertType | String | N | 营业执照证件类型,非小微商户必填 个体及企业商户:仅支持 19:社会统一信用代码 事业单位:仅支持 z2:事业单位法人证书 政府机关:仅支持 z2:事业单位法人证书,z4:其他证明文件 社会组织:仅支持 z5:民办非企业单位登记证书,z6:基金会法人登记证书,z4:其他证明文件 |
busAddr | String | Y | 营业详细地址,需包含省市区,示例:广东省深圳市龙华新区大道513号远景大厦 |
regAddr | String | N | 注册地址,默认 营业地址一致 |
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数据)
参数 | 类型(长度) | 必填 | 参数说明 |
---|---|---|---|
sysFlowId | String(25) | N | 入网申请流水号 |
6、业务响应码 网关公共响应码
响应码 | 响应码描述 | 解决方案 |
---|---|---|
0000 | 成功 | |
B519999 | 系统异常 | |
B519998 | 请勿频繁调用 | |
A519997 | 重复的请求 | |
A519996 | 非法金额 | |
A519990 | 请求参数非法 | |
A510001 | 发起方有误 | |
A510004 | 代理商编号不存在 | |
B510005 | 代理商与发起方不是上下级关系 | |
A510010 | 入网信息已列入黑名单 | |
A510011 | 证件号已列入黑名单 | |
A510012 | 营业执照已列入黑名单 | |
A510013 | 卡号已列入黑名单 | |
A510014 | 手机号码已列入黑名单 | |
B510020 | 注册次数超限 | |
B510021 | 证件号码注册次数超限 | |
B510022 | 营业执照号注册次数超限 | |
B510023 | 手机号注册次数超限 | |
B510050 | 发起方相关错误 | |
B510052 | 发起方不支持此cardBin | |
B510053 | 发起方不支持当前商户类型入网 | |
B510080 | 省市区相关错误 | |
A510081 | 地区码不存在 | |
A510082 | 地区与上级地区码不是上下级关系 | |
A510083 | 卡bin不存在 | |
B510084 | mcc码错误 | |
A510085 | 结算卡类型与银行卡实际类型不匹配 上送类型:21 实际类型: | |
B519994 | 暂停服务 | 尊敬的云商服用户,您好!从即日起,云商服的服务时间调整为每日7时至20时59分,其余时段(当日21:00~次日06:59)暂停服务,敬请谅解 |
A510009 | 数据不存在 | 请检查参数是否正确 |
B510044 | 企业实名认证不通过 | |
A510214 | 请稍后再试 | 根据返回提示操作 |
A510017 | 业务方入网申请流水号重复 |