目录
商户进件
接口地址
生产环境:https://cus.allinpay.com/cusapi/merchantapi/add
测试环境:https://syb-test.allinpay.com/vsppcusapi/merchantapi/add
使用场景:
商户调用接口进件,进件审核中或者进件成功,不允许重复进件.进件失败允许再次进件
注:开通电子协议代理商,需开发5.1,5.2,5.3,5.4接口。
请求参数:
参数 |
参数名称 |
取值 |
可空 |
最大长度(字节) |
备注 |
orgid |
机构号 |
通联分配的代理商号 |
否 |
15 |
|
cusid |
商户号 |
通联分配的商户号 |
否 |
15 |
等于orgid |
appid |
应用ID |
通联分配的代理商APPID |
否 |
8 |
|
version |
版本号 |
接口版本号 |
可 |
2 |
默认填11 |
randomstr |
随机字符串 |
商户自行生成的随机字符串 |
否 |
32 |
|
merchantid |
代理商商户号 |
代理商平台商户号 |
否 |
32 |
代理商系统商户唯一识别号 |
merchantname |
商户名称 |
|
否 |
100 |
|
shortname |
商户简称 |
|
否 |
40 |
无执照商户请按照 实际场所的经营门店名称填写 |
cusengname |
英文名称 |
|
可 |
100 |
开通外卡产品时必填 |
cusengshortname |
英文简称 |
|
可 |
100 |
开通外卡产品时必填 |
servicephone |
客服电话 |
|
否 |
32 |
|
mccid |
所属行业 |
详见附录 |
否 |
8 |
|
comproperty |
商户性质 |
1|3|4|6 |
否 |
1 |
1.企业 3.个体户 4.个人 |
corpbusname |
营业执照名称 |
|
是 |
64 |
商户性质非个人时需要填写 |
creditcode |
统一社会 信用代码证 |
|
是 |
32 |
商户性质非个人时需要填写 |
creditcodeexpire |
社会信用代码证 有效期 |
|
是 |
10 |
商户性质非个人时需要填写 |
legal |
法人姓名 |
|
否 |
20 |
|
legalidtype |
法人代表 证件类型 |
01、04、05 |
否 |
2 |
01身份证 04港澳通行证 05台湾通行证 |
legalidno |
法人代表证件号 |
|
否 |
50 |
|
legalidexpire |
法人身份证 有效期 |
|
否 |
10 |
yyyy-mm-dd或长期 |
address |
注册地址 |
|
否 |
200 |
注册地址需包含省市 |
contactperson |
商户负责人 |
|
否 |
30 |
财务联系人(收短信用) |
contactphone |
商户负责人电话 |
|
否 |
20 |
财务联系人电话 |
clearmode |
结算方式 |
1 |
否 |
1 |
0-商户自主提现 1-结算到银行卡 2-结算到通联电子账户 |
acctid |
账户号 |
|
否 |
32 |
|
acctname |
账户名 |
|
否 |
80 |
|
accttype |
账户类型 |
0|1 |
否 |
1 |
0-对私 1-对公 |
accttp |
卡折类型 |
00|01 |
否 |
2 |
00-借记卡 01-存折 |
bankcode |
所属银行 |
见附录 |
否 |
8 |
|
cnapsno |
支付行号 |
见附录 |
否 |
30 |
|
notifyurl |
回调url |
进件成功的回调通知url |
否 |
160 |
|
corpbuspic |
营业执照照片 |
照片url 最大2M |
是 |
160 |
商户性质非个人时需要填写 |
legalidpicfront |
法人身份证 肖像面 |
照片url 最大1M |
否 |
160 |
人像面 |
legalidpicback |
法人身份证 国徽面 |
照片url 最大1M |
否 |
160 |
国徽面 |
legalpic |
经营者 手持身份证照片 |
照片url 最大2M |
是 |
160 |
商户性质为个人时必填 |
storepic |
商户门头照片 |
照片url 最大2M |
否 |
160 |
|
storeinnerpic |
经营内景照片 |
照片url 最大2M |
否 |
160 |
|
bizplacepic |
经营场所 证明文件 |
照片URL 最大2M |
是 |
160 |
不限于营业场所租赁协议或者产权证明 集中经营场所管理方出具的证明文件等 商户性质个人时需要填写 |
otherfile |
其他审核材料 |
文件url 必须为zip文件,最大5M |
是 |
160 |
所有其他审核材料打包成zip提交 (注:压缩包里不能放入文件夹) |
expanduser |
拓展人 |
|
否 |
50 |
|
subbranchlist |
门店信息 |
门店列表的json数组 |
否 |
4000 |
|
prodlist |
支付产品 信息列表 |
产品列表的json数组 |
否 |
1000 |
|
sign |
签名 |
详见安全规范 |
否 |
32 |
|
addfacusid |
所属父客户 |
|
是 |
15 |
所在机构资金归集时 该字段不能为空 |
settidno |
结算人身份证号 |
|
是 |
18 |
结算账户对私时 结算人身份证号不能为空 |
holdername |
控股股东姓名 |
|
是 |
64 |
商户性质为企业、个体户时必填 |
holderidno |
控股股东身份证 |
|
是 |
18 |
商户性质为企业、个体户时必填 |
holderexpire |
控股股东有效期 |
|
是 |
12 |
商户性质为企业、个体户时必填 |
registerfund |
注册资本 |
1: 注册资本<10万元 2: 10万元<注册资本<20万元 3: 20万元<注册资本<50万元 4: 50万元<注册资本<100万元 5: 注册资本>100万元 |
是 |
1 |
商户性质为企业、个体户时必填 |
stafftotal |
员工人数 |
1: 员工数量<10 2: 10<员工数量<20 3: 20<员工数量<50 4: 50<员工数量<100 5: 员工数量>100 |
是 |
1 |
商户性质为企业、个体户时必填 |
operatelimit |
经营区域 |
1:城区 2: 郊区 3:边远地区 |
是 |
1 |
商户性质为企业、个体户时必填 |
inspect |
经营地段 |
1:商业区 2:工业区 3:住宅区 |
是 |
1 |
商户性质为企业、个体户时必填 |
thrcertflag |
是否三证合一 |
1:是 0:否 |
是 |
1 |
默认:1 |
organcode |
组织机构 代码证号 |
|
是 |
64 |
三证合一否时需要填写
|
organexpire |
组织机构代码证 有效期 |
|
是 |
10 |
三证合一否时需要填写
|
busconactperson |
业务联系人姓名 |
|
是 |
32 |
非个人类商户必填 |
busconacttel |
业务联系人电话 |
|
是 |
20 |
非个人类商户必填 |
offlag |
线上线下 业务场景 |
0 线下 1 线上 |
否 |
1 |
为空时默认为线下场景 |
unsdremark |
渠道备注 |
|
是 |
100 |
渠道备注信息 |
agreetype |
无纸化标识 |
非电子协议进件可不填 |
是 |
2 |
1:电子协议 2:纸质协议 |
|
图片json字符串 |
图片url的键值对 |
是 |
3000 |
详见下方picurljson信息 |
cusurl |
网站url或 下载地址或 平台名称 |
|
是 |
100 |
开通网关(含B2B、APP)、 快捷、云闪付APP 或线上场景必填 |
webname |
网站名称/ 应用名称 |
|
是 |
50 |
开通网关(含B2B、APP)、 快捷、云闪付APP 或线上场景必填 |
legaldetail |
法人信息 json字符串 |
|
否 |
256 |
json内详情见下说明 |
bnfdetail |
受益人信息 json字符串 |
|
否 |
512 |
|
taxdetail |
税务登记详情 json字符串 |
在商户性质为企业,选择非三证合一时,税务登记证信息必填 |
否 |
500 |
json内详情见下说明 |
busdetail |
经营内容 |
|
否 |
100 |
|
signtype |
签名类型 |
|
否 |
|
RSA/SM2 |
businessplace |
经营场所 |
1/2/3/4 为空时默认填1 |
是 |
1 |
1、独立门店、连锁店、专卖店 2、综合卖场 3、批发市场 4、其它 |
busaddress |
经营地址 |
|
否 |
60 |
商户经营地址 |
districtcode |
所在区 |
|
否 |
10 |
见附录 |
reqid |
进件请求流水号 |
|
是 |
50 |
|
settremark |
结算摘要前缀 |
|
是 |
60 |
仅当非自主提现时获取 |
creditCodeType |
营业执照类型 |
|
是 |
100 |
营业执照类型 |
creditCodeStartdate |
营业证件 成立日期 |
|
是 |
10 |
营业证件成立日期 yyyy-MM-dd |
legalidStartdate |
法人证件 生效日期 |
|
是 |
10 |
法人证件生效日期 yyyy-MM-dd |
icpinfo |
icp备案号 |
|
是 |
30 |
|
pubacctinfo |
对公账户信息 |
格式如下: 对公账户号#对公账户开户省#对公账户开户市#所属银行#支付行号#对公账号名称 |
|
|
商户性质为企业 事业单位及其他组织 结算账户对私时必填 作为商户信息扩展字段 与结算信息无关 |
appscenario |
应用场景 |
|
是 |
10 |
01-PC网站 02-APP/公众号/小程序(可复选) |
quickcash |
快速提现开关 |
|
是 |
2 |
0 开通 1 关闭 |
cleartimerule |
结算时间 |
|
是 |
2 |
枚举值参考附录6.9 填结算枚举值 |
electnotify |
电子协议签约 回调地址 |
|
是 |
512 |
电子协议签约回调地址 此字段为空时通知到进件回调url |
credentcheckdate |
营业执照 核准日期 |
|
是 |
10 |
yyyy-mm-dd |
feecycle |
收费周期字段 |
若上送空值,默认取代理商“所属子商户计费周期”字段值。 |
是 |
2 |
2 日结 4 月结 |
响应参数:
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
retcode |
返回码 |
SUCCESS/FAIL |
否 |
8 |
SUCCESS-请求成功 FAIL-请求或前端处理失败,具体看retmsg |
retmsg |
返回码说明 |
|
是 |
100 |
|
trxstatus |
交易状态码 |
1000|1999 |
否 |
4 |
1000: 获取结果成功 1999:获取结果失败 |
orgid |
机构号 |
平台分配的机构号 |
否 |
15 |
与请求时一致 |
cusid |
商户号 |
商户号 |
否 |
15 |
与请求时一致 |
以下信息只有当retcode为SUCCESS时有返回 |
|||||
auditstatus |
审核状态 |
00|01|02|03|04 |
否 |
15 |
00-受理成功待提交审核 01-审核中 02-审核通过 03-审核失败 04-提交审核失败 |
errmsg |
错误信息 |
|
是 |
100 |
|
merchantid |
代理商商户号 |
|
否 |
32 |
|
reqid |
进件请求流水号 |
|
是 |
50 |
|
sign |
签名 |
|
否 |
32 |
详见安全规范 |
subbranchlist门店信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
|
branchno |
门店编号 |
|
是 |
4 |
进件时,为空 |
|
branchname |
门店名称 |
|
否 |
60 |
同一商户名称唯一 |
|
branchaddr |
门店地址 |
|
否 |
150 |
|
|
contactperson |
门店联系人 |
|
否 |
30 |
|
|
contactphone |
门店联系人电话 |
|
否 |
20 |
|
|
districtcode |
所在区 |
|
否 |
10 |
见附录 |
|
以下字段仅在商户进件时需配置终端的门店信息中存在: |
||||||
printnum |
打印联数 |
|
是 |
2 |
默认为:2 |
|
termnum |
门店终端数 |
|
是 |
1 |
单门店默认最大终端数:10 |
|
rejecttrxcodes |
禁用交易类型 |
VSP002 消费撤销 VSP003 消费退货 VSP004 预授权 VSP005 预授权撤销 VSP006 预授权完成 VSP007 预授权完成撤销 VSP502 微信撤销 VSP503 微信退货 VSP512 支付宝撤销 VSP513 支付宝退货 VSP506 QQ钱包撤销 VSP507 QQ钱包退货 VSP552 银联扫码撤销 VSP553 银联扫码退货 VSP011 扫码预消费 VSP013 扫码预消费完成 VSP014 扫码预消费完成退货 |
是 |
100 |
填入示例:VSP002,VSP003,VSP005 |
subbranchlist=[{"contactperson":"文西","contactphone":"0471-4917000","branchaddr":"天河体育西","branchname":"体育西门店","termnum":"0"}]
prodlist产品信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
pid |
产品名称 |
P0003 |
否 |
8 |
P0003-网上收银 |
mtrxcode |
交易类型 |
详见附录交易类型 |
否 |
20 |
|
feerate |
费率 |
千分之 |
否 |
8 |
例如3.5代表千分之3.5(区分借贷分离时为借记卡费率) |
creditrate |
信用卡费率 |
千分之 |
是 |
8 |
例如3.5代表千分之3.5 (借贷分离者必填) |
feepen |
元/笔 |
元 |
是 |
8 |
仅当网上收银-网关B2B 时配置其他交易类型为空 |
lowlimit |
保底(仅支持借记卡) |
元 |
是 |
|
例如保底10元填:10 |
toplimit |
封顶(仅支持借记卡) |
元 |
是 |
|
例如封顶100元填:100 |
rankfeearr |
阶梯费率json |
是 |
2000 |
阶梯费率数组 |
prodlist=[{"creditrate":"5.8","pid":"P0003","mtrxcode":"VSP301","feerate":"5"},{"pid":"P0003","feepen":"7","mtrxcode":"VSP534"}]
rankfeearr数组详细字段列表
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
feerate |
借记卡费率 |
为千分比 |
是 |
8 |
例如3.5代表千分之3.5 |
creditrate |
贷记卡费率 |
为千分比 |
是 |
8 |
例如3.5代表千分之3.5或单笔3.5元 |
lowlimit |
借记卡保底值 |
元 |
是 |
|
例如保底10元填:10 |
toplimit |
借记卡封顶值 |
元 |
是 |
|
例如保底10元填:10 |
rank |
区间 |
元 |
是 |
8 |
|
[{"rank":"0-1000","feerate":"3.5","creditrate":"","lowlimit":"10","toplimit":"100"},{"rank":"1000-5000","feerate":"4.5","creditrate":"","lowlimit":"20","toplimit":"100"},{"rank":"5000-","feerate":"5.5","creditrate":"","lowlimit":"10","toplimit":"100"}]
picurljson图片信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
settlebankpic |
银行卡正面照 |
图片链接url |
是 |
256 |
账户类型为对私时,“settlebankpic(银行卡正面照)”为必填; |
acctlicensepic |
开户许可证照片 |
图片链接url |
是 |
256 |
账户类型为对公时,“acctlicensepic(开户许可证照片)”为必填 |
homepagepic |
纸质协议首页 |
图片链接url |
是 |
256 |
|
finalpagepic |
纸质协议尾页 |
图片链接url |
是 |
256 |
|
peasonheadpic |
经营者与店铺门头合照 |
图片链接url |
是 |
256 |
只支持图片格式 |
orgcodepic |
组织机构代码证照片 |
图片链接url |
是 |
256 |
非三证合一时,可上传组织机构代码证 |
registerpic |
注册登记表 |
图片链接url |
是 |
256 |
选择纸质协议时,可上传注册登记表照片 |
authorpic |
签字授权书 |
图片链接url |
是 |
256 |
法人手机号仍不能通过运营商三要素验证,可上传签字授权书以便合规性审核 |
govercodepic |
事业单位法人证书 |
图片链接url |
是 |
256 |
商户性质为事业单位时必填 |
settauthpic |
结算账户授权书 |
图片链接url |
是 |
256 |
结算账户对私时,且允许法人与结算账户不一致时,必填 |
picurljson={"peasonheadpic":"http://172.0.1.10/019.jpg","orgcodepic":"http://172.0.1.10/14.jpg","homepagepic":"http://172.0.1.10/13.jpg","settlebankpic":"http://172.0.1.10/012.jpg"}
legaldetail法人信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
persontel |
法人手机号 |
11 |
否 |
11 |
|
nationality |
国籍 |
例如:中国 |
否 |
50 |
|
sex |
性别 |
1/2 |
否 |
2 |
1:男 2:女 |
occupation |
职业 |
1/2/3/4/5/6/7/8 |
否 |
2 |
1:国家机关、党群组织、企业、事业单位人员 2:专业技术人员 3:办事人员和有关人员 4:商业、服务业人员 5:农、林、牧、渔、水利业生产人员 6:生产、运输设备操作人员及有关人员 7:军人 8:其他
|
personaddr |
住址 |
例:广东省广州市天河区体育西路107号 |
否 |
100 |
|
legaldetail={"occupation":"1","nationality":"中国","sex":"1","persontel":"13800000000","personaddr":"广东省广州市天河区体育西路东省广州河区体育西路107号"}
taxdetail税务登记证信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
taxregcode |
税务登记号码 |
30 |
否 |
30 |
|
taxcodeexpire |
税务登记证日期 |
例如:2020-08-25 |
否 |
10 |
|
taxcodepic |
税务登记证照片 |
图片链接 |
否 |
256 |
|
taxdetail={"taxcodepic":"https://test.cesgi.com/14.jpg","taxregcode":"123414241231312311","taxcodeexpire":"2029-01-14"}
bnfdetail受益人信息
字段ID |
字段名称 |
取值 |
可空 |
最大长度 |
备注 |
---|---|---|---|---|---|
bnfflag |
是否与法人信息一致 |
0/1 |
是 |
1 |
0一致 (取法人姓名,证件类型,证件号,证件有效期信息) 1 不一致 |
bnfname |
姓名 |
张三 |
是 |
20 |
与法人不一致时必填 |
bnftype |
受益人证件类型 |
01、04、05 |
是 |
2 |
与法人不一致时必填 04港澳通行证 05台湾通行证 |
bnfidno |
受益人证件号 |
|
是 |
20 |
与法人不一致时必填 |
bnfexpire |
受益人证件有效期 |
2020-10-21 |
是 |
10 |
与法人不一致时必填 |
mertype |
商户类型 |
|
是 |
2 |
企业、事业单位、其他组织必填 |
filetype |
证明材料类型 |
61/62/63/64/65/66/67/68 “商户类型”选择为“公司(不包含国有企业)”、 “合伙企业”的 支持上传受益所有人判定的证明材料
|
是 |
2 |
61:注册证书(受益人)" 67:年报(受益人) |
fileurl |
证明材料url |
支持图片和rar压缩包 “商户类型”选择为“公司(不包含国有企业)”、 “合伙企业”的 支持上传受益所有人判定的证明材料
|
是 |
256 |
|
personaddr |
住址 |
例:广东省广州事天河区体育西路107号 |
是 |
100 |
与法人不一致时必填 |
frnmngflag |
是否高管 |
0/1 |
是 |
1 |
与法人不一致时必填 1:是 |
bnflevel |
受益所有人判定标准 |
1/2/3 |
是 |
2 |
仅mertype选1/2的时候需要填写: 1.拥有超过25%合伙权益的自然人 2.通过人事、财务等其他方式对公司进行控制的自然人 3.执行事务合伙人 |
其中mertype说明
枚举值 |
说明 |
1 |
公司(不包含国有企业) 仅进件商户类型为企业时可填 |
2 |
合伙企业 仅进件商户类型为企业时可填 |
3 |
个人独资企业 仅进件商户类型为企业时可填 |
4 |
受政府控制的企业(国有企业) 仅进件商户类型为企业时可填 |
5 |
事业单位(不包含参照公务员法管理的事业单位) 仅进件商户类型为事业单位时可填 |
6 |
各级党的机关、国家权力机关、行政机关、司法机关、军事机关、人民政协机关和人民解放军、武警部队、参照公务员法管理的事业单位 仅进件商户类型为事业单位时可填 |
7 |
不具备法人资格的专业服务机构(如律师事务所和会计师事务所等) 仅进件商户类型为其他组织时可填 |
8 |
经营农林渔牧产业的非公司制农民专业合作组织 仅进件商户类型为其他组织时可填 |
9 |
社会团体、基金会、社会服务机构(民办非企业单位)和外国商会 仅进件商户类型为其他组织时可填 |
10 |
政府间国际组织、外国政府驻华使领馆及办事处等机构及组织 仅进件商户类型为其他组织时可填 |