代理商服务API
1.文档说明
1.1版本说明
1.2对接说明
1.3协议规则
1.4安全规范
1.5测试参数
2.商户信息管理
2.1商户进件
2.2商户审核状态查询
2.3进件成功商户信息查询
2.4商户进件结果通知
2.5商户基本信息管理接口
2.6商户基本信息修改异步结果通知
2.7商户门店信息管理接口
2.8商户门店信息修改异步结果通知
2.9商户产品信息管理接口
2.10商户产品信息修改异步结果通知
2.11商户终端信息管理接口
2.12商户终端新增异步结果通知
2.13商户异常状态变更通知
2.14商户结算信息管理接口
2.15文件上传接口
2.16商户合规性审核结果异步通知
2.17合规性审核补录统一h5接口
2.18合规性补录API接口
2.19商户合规性补录结果异步通知
2.20合规性状态查询接口
2.21秒到开通H5接口
2.22商户证件到期结果文件查询
2.23商户证件到期结果文件查询回调
2.24代理商商户异步结果回调通知(秒到、AT认证)
3.业务拓展管理
3.1商户套餐查询接口
3.2商户二维码绑定申请接口
3.3商户二维码绑定确认接口
3.4商户二维码解绑接口
3.5商户二维码解绑确认接口
3.6商户二维码绑定关系查询
3.7IOT设备绑定和解绑接口
3.8IOT设备查询接口
3.9商户手续费部分补贴配置查询
3.10分账协议授权配置
3.11分账协议授权查询
3.12支付宝NFC设备绑定查询接口
3.13支付宝NFC设备配置接口
3.14商户交易通知(POS/当面付)
3.15结算成功通知
4.商户活动管理
4.1商户活动报名API接口
4.2活动报名h5接口
4.3活动状态查询
4.4商户活动报名结果通知
5.电子协议管理
5.1电子协议签约状态查询
5.2电子协议重发接口
5.3电子协议URL查询
5.4电子协议签约通知
6.渠道能力管理
6.1AT商户认证统一H5接口
6.2微信/支付宝认证状态查询
6.3AT商户认证状态异步回调通知
6.4微信子商户参数配置
6.5子商户微信配置信息查询
6.6渠道子商户查询
6.7H5获取微信OPENID
6.8微信发放代金券
6.9查询微信代金券批次详情
6.10下载微信代金券批次核销明细
6.11下载微信代金券批次退款明细
6.12查询微信代金券详情
6.13微信点餐同步
7.对账能力管理
7.1获取对账单接口
7.2获取结算单接口
8.附录
8.1交易类型说明
8.2省市地区码
8.3所属银行代码
8.4所属行业
8.5支付行号
8.6结算id对应商户特征
8.7可能不明确的mcc及对应可选项(0727)
8.8结算时间枚举值
8.9参考demo
8.10代理商对账单CSV字段说明
8.11对账单交易类型说明
8.12通知交易类型
通联核心产品文档中心
-
+
首页
1.1版本说明
●2025.02.20 2.1进件API新增收费周期字段(feecycle,枚举值:2日结 4月结) ●2025.01.09 1.电子协议重发接口,“电子协议类型”增加枚举值12,用于商户信息变更授权模式重发授权短信。 2.接口2.13商户状态变更通知增加notifytype字段,固定值为cusstatechange ●2024.12.19 1.合规性后督handledetail字段内相关枚举变更;涉及接口2.16合规性审核结果异步通知以及接口2.20合规性状态查询 2.商户结算信息修改接口2.14,修改acctid或者acctname或者clearmode时,允许上送结算账户图片 ●2024.11.21 1.新增支付宝NFC设备查询接口3.12以及配置接口3.13 2.增加支持当面付银联扫码支付进件 ●2024.10.25 1. 2.16,2.17,2.18增加支持后督模式 2. 2.3增加返回字段holidayfee(节假日手续费加收),feecycle(加收手续费收费周期) 3.增加接口2.38手续费部分补贴配置查询 ●2024.09.19 1. 2.14,2.16增加返回字段rgctype(合规性模式) 2. 增加接口2.36二维码绑定关系查询 ●2024.09.11 完善2.9.商户产品信息接口查询返回的prodlist ●2024.09.05 1.新增2.30商户二维码绑定接口 2.新增2.31商户二维码绑定确认接口 3.新增2.32商户二维码解绑接口 4.新增2.33商户二维码解绑确认接口 5.新增2.34IOT设备绑定和解绑接口 6.新增2.35IOT设备绑定查询接口 ●2024.08.26 1. 新增分账授权配置接口2.28以及查询接口2.29 2. 3.2无纸化进件协议重发接口改为电子协议重发接口,支持分账协议的重发 ●2024.07.27 1、接口2.3商户信息查询增加字段addfacusid(所属父客户),settidno(结算人身份证号)返回 ●2024.06.27 1、接口2.3商户信息查询增加字段cleartimerule(结算时间)返回 2、2.14合规性审核通知返回调整 A.营业执照 “营业执照工商章未有编码”更改为“营业证件号不清晰” B.授权书 “具体业务未明确”更改为“复印件/扫描件未盖公司章”; C.租赁合同 a.“合同不规范/无合同”更改为“日期不规范/无合同”; b. 新增一项:截图/翻拍; D.结算卡 a.“账号不清晰”改为“账号不清晰/不一致”; b.新增一项:账户/卡折类型不一致; ●2023.10.25 1、接口2.1中字段bnfdetail受益人信息json内部调整,去除persontel、nationality、sex、occupation四个key;同步新增mertype、filetype、fileurl,bnflevel;2.3查询接口受益人信息字段同步修改 ●2023.10.7 生产相关接口域名变更为https://cus.allinpay.com,兼容原域名https://vsp.allinpay.com ●2023.9.19 1、2.1商户进件接口新增营业执照核准日期字段credentcheckdate ●2023.7.27 1、2.14合规性审核通知增加字段needrepair(是否需要补录) 2、增加2.25合规性补录API接口 3、增加2.26合规性补录通知 4、4.2活动状态查询接口返回增加字段actdetail(报名详情) 5、摘除2.5商户基本信息修改中的结算信息相关字段 6、增加2.27商户结算信息修改接口 7、活动相关接口增加微信商业医疗行业返佣活动报名 8. 3.1无纸化进件协议签约状态查询删除字段electsigntype(协议类型) ●2023.6.15 1、2.1商户进件接口新增结算时间字段cleartimerule以及电子协议通知url字段electnotify ●2023.4.26 1、新增2.23证件到期结果文件查询接口 2、新增2.24证件到期结果文件查询回调 ●2023.3.23 1、代理商进件API支持开通外卡收银(本次需求适用于代理商接口权限为“ 开通电子协议且开通进件免审权限 ”情况) 2、代理商进件API入网增加以下强校验 3、2.1进件接口新增字段英文名称cusengname ,英文简称cusengshortname 业务场景为线上,则应用场景必填。 业务场景为线下,且开通快捷支付、网关支付、网关支付(B2B)、云闪付APP、网关支付(APP)其中一个,则应用场景必填。 ●2023.2.15 1、2.1进件接口新增字段quickcash(快速提现开关) ●2022.12.29 1、2.1进件接口新增字段creditCodeType(营业执照类型)、creditCodeStartdate(营业证件成立日期)、legalidStartdate(法人证件生效日期)、icpinfo(icp备案号)、appscenario(应用场景) 2、2.5商户基本信息修改接口新增字段creditCodeType(营业执照类型)、creditCodeStartdate(营业证件成立日期)、legalidStartdate(法人证件生效日期) 3、4.1活动报名接口增加2个微信特费活动 07 教育行业非学校主体商户餐饮消费场景费率活动 08 教育行业学校主体食堂场景费率活动 4、2.17活动单项报名统一h5接口新增活动ID 681教育行业非学校主体商户餐饮消费场景费率活动 682教育行业学校主体食堂场景费率活动 若应用场景为枚举值“01-PC网站”,则“网站url或下载地址”及“ICP备案编号”必填;若为“02-APP/公众号/小程序”,则“网站名称/应用名称”必填。(01、02可复选) ●2022.10.26 1、增加支持当面付产品进件 ●2022.09.19 1、新增2.21AT认证统一H5接口,新增2.22AT认证状态异步回调通知接口 ●2022.06.29 1、新增2.20微信认证状态查询接口 ●2022.06.22 1、2.5商户信息修改接口支持修改电子账户号tlbankno。 ●2022.04.13 1、2.1进件接口受益人信息“bnfdetail”变更为必填。如需默认取法人信息,则bnfdetail下的bnfflag字段需上送为"0"。。(注:暂为非必填,5月18日生效) ●2022.01.13 1、合规性接口2.14与2.16新增审核状态(七天未处理系统延迟冻结)和审核结果(延迟冻结) 2、2.16合规性审核查询接口新增返回字段审核异常错误信息handlemsg和审核详情json数组handledetail ●2021.12.29 1、更新附录银行代码列表,支付行号列表 ●2021.10.20 1、2.1进件接口pubacctinfo字段由原格式“对公账户号#对公账户开户省#对公账户开户市#所属银行#支付行号#对公账户名称”变更为“对公账户号#支付行号#对公账户名称”,提交时会判断上传的支付行号是否存在,若存在,取该支付行的所属银行、开户省、开户市传入客户信息;若不存在则直接拦截(兼容存量格式请求)。 2.、优化2.1进件接口门店终端数量限制,存量及后续新增代理商,默认限额为5,支持修改,支持最多200个终端 ●2021.09.15 1、2.1进件接口新增字段settremark 结算摘要前缀 2、2.3商户信息查询接口新增返回字段settremark 结算摘要前缀 3、统一文档签名规范,所有接口对接参数由原cusid(代理商号),mchid(通联商户号)改成orgid(通联代理商号),cusid(通联商户号)请求。部分接口因未生成通联商户号,则请求时cusid=orgid ,如2.1商户进件的接口。本次改造兼容旧版接口,不影响存量代理商。 ●2021.08.20 1. 新增2.21商户套餐查询接口 2. 新增5.7查询微信代金券批次详情接口 3. 新增5.8下载微信代金券批次核销明细接口 4 新增5.9下载微信代金券批次退款明细接口新增 5. 新增5.10查询微信代金券详情接口 ●2021.07.22 1.【代理商商户进件接口2.1】增加字段进件请求流水号reqid 2.【代理商审核状态查询接口2.2】增加字段进件请求流水号reqid,可通过进件请求流水号reqid查询进件审核状态 3.【代理商商户进件结果通知2.4】增加返回进件请求流水号reqid ●2021.06.24 【代理商商户进件接口2.1】 1.去除“innermanage(签约类型)”。) 2.去除“legalphone(法人手机号)”(注:请求信息“法人信息json字符串legaldetail”中,已包含“persontel(法人手机号)”且为必填项,故删除重复信息)。 3.调整“图片json字符串picurljson”中部分字段的属性,即账户类型为对私时,“settlebankpic(银行卡正面照)”设置为必填;账户类型为对公时,“acctlicensepic(开户许可证照片)”设置为必填。 4.调整“受益人信息json字符串bnfdetail”中“persontel(法人手机号)”字段名称为“受益人手机号”。 ●2021.04.25 1.新增代理商秒到H5接口 ●2021.04.15 1.【代理商商户进件接口2.1】请求信息去除“所在省”、“所在市”,商户基本信息新增字段所在区districtcode、经营地址busaddress,门店信息新增字段所在区districtcode。(四月份版本可兼容填写“所在省”、“所在市”的情况,当送“所在区”时,只检查所在区) 字段举例: 【districtcode】内蒙古鄂尔多斯达拉特旗 districtcode=150621 【busaddress】填写去除省市区后的具体地址,如XX路YY号107室 2.【代理商商户信息查询接口2.3】返回新增所在区districtcode、经营地址busaddress。 3.【代理商商户信息编辑接口2.5】请求信息新增所在区districtcode、经营地址busaddress。修改所在区范围仅在商户所在省市内 4.【商户门店信息接口2.7】新增所在区districtcode(四月份版本非必填,五月份版本必填) 5. 更新附录7.2地区码 6. 【代理商商户合规性审核补录统一h5接口2.17】(注:原请求地址保留2个月并在2021年6月23日删除) 生产地址:https://syb.allinpay.com/wxweb/commonh5api/repaircusrgc.wx 变更为https://vsp.allinpay.com/cusapi/merchantapi/repaircusrgc 测试地址:https://test.allinpaygd.com/wxweb/commonh5api/repaircusrgc.wx 变更为https://test.allinpaygd.com/vsppcusapi/merchantapi/repaircusrgc 7. 【代理商H5获取微信OPENID接口5.3】(注:原请求地址保留2个月并在2021年6月23日删除) 生产地址:https://syb.allinpay.com/cuswap/wxopen/getopenid.wx 变更为https://vsp.allinpay.com/cusapi/wxopen/getopenid 测试地址:https://test.allinpaygd.com/cuswap/wxopen/getopenid.wx 变更为https://test.allinpaygd.com/vsppcusapi/wxopen/getopenid ●2021.03.17 1、3.3无纸化进件电子协议URL接口查询增加字段redirecturl(重定向url),支持签约完成跳转 2、增加2.19活动单项报名统一h5 接口 ●2020.12.30 1、下架6.3移动支付非标渠道报备接口 ●2020.12.17 1、商户性质增加支持事业单位 2、3.1商户进件中,以下信息修改为必填:, Ø 商户性质为:企业,营业证件非三证合一时:taxdetail(税务登记详情); Ø 商户性质为个人时:peasonheadpic(经营者与店铺门头合照);legalpic经营者手持身份证照片 Ø subbranchlist(门店信息)。 3. 3.7商户门店信息接口中,删除门店时,至少需留存一条门店记录。若删除后门店记录为空,则系统提示“删除失败,商户门店信息不允许为空。 4. 3.9商户产品信息接口”中,新增产品时,将检查商户是否存在门店信息,若不存在则系统提示“商户无门店,无法开通产品。 5. 3.1商户进件中,增加pubacctinfo(对公户信息)字段格式的强校验,具体格式为:对公账户号#对公账户开户省#对公账户开户市#所属银行#支付行号; ●2020.11.18 1、3.1进件接口picurljson图片json字段新增组织机构代码证图片orgcodepic、注册登记表registerpic、签字授权书字段authorpic 2、无纸化进件新增运营商三要素校验 3、所有同步接口返回新增状态码trxstatus 其中1000表示获取数据成功 1999获取数据失败 4、新增3.17合规性审核补录统一h5接口 5、5.1活动报名接口新增饭堂,教培报名 ●2020.11.10 1、新增6.6微信点餐同步接口 ●2020.10.22 1、3.1进件接口字段名称修改:字段“网站url”,文案改为“网站url或下载地址或平台名称;网站名称改为“网站名称/应用名称”,结算方式新增支持结算到通联电子账户,并新增字段:bnfdetail(受益人) 、tlbankno(通联电子账户号)、taxdetail(税务登记详情),注:在商户性质为企业,选择非三证合一时,税务登记详情必填 2、商户性质1统一修改为企业商户 3、3.15合规性审核结果异步通知增加certifiedresult字段 4、3.14合规性补录接口增加certifiedimg增加字段 5、新增支持三种网上收银的产品类型:云闪付APP、网关支付(APP)、网关B2B,并支持网关B2B的feepen(元/笔)产品费率格式 ●2020.09.24 1、3.1商户进件接口picurljson字段新增经营者店铺门头合照(peasonheadpic) 当个人类时必填。(暂为非必填,11月生效) 2、新增3.14合规性补录接口,3.15商户合规性审核结果异步通知接口,3.16商户合规性补录结果异步通知接口 ●2020.09.03 1、4.3无纸化进件电子协议URL接口查询新增返回无纸化签约协议字段(sybsignurl)并以sybsignurl为准,原字段收银宝业务协议(sybserviceurl)及结算账户委托协议(accounturl)将于12月废弃。 ●2020.08.12 1、6.2渠道子商户查询接口新增结算id字段(settid),8月27日生效。 ●2020.08.12 1、8月26日会增加对3.1进件接口字段pubacctinfo(对公户信息)字段格式的强校验,具体格式为:对公账户号#对公账户开户省#对公账户开户市#所属银行#支付行号 2、账户类型为对私且卡折类型为借记卡时,支付行号可为空 ●2020.07.22 3.1商户进件、3.3商户信息查询、3.5商户基本信息修改三个接口新增必填字段:legaldetail(反洗钱法人信息),busdetail(经营内容)7月22日-8月18日为过渡期,该两个字段为非必填。8月19日起,该两个字段为必填字段。请合作方尽快安排更新 ●2020.06.04 1. 3.1商户进件接口新增网站url字段cusurl ,网站名称字段webname 2. 新增3.13文件上传接口 ●2020.04.16 1. 商户信息查询接口新增返回字段secondswitch(是否秒到) iscollect(是否归集) 2. 新增8.1合作方人员信息查询接口 3.商户进件接口picurljson字段新增纸质协议首页,纸质协议尾页图片上传 4.生产接口域名前缀增加cusapi,测试接口域名由vsppcusweb变更为vsppcusapi(注:原请求地址保留3个月并在2020年7月15日删除) 如商户进件 生产地址:https://vsp.allinpay.com/merchantapi/add 变更为https://vsp.allinpay.com/cusapi/merchantapi/add 测试地址:https://test.allinpaygd.com/vsppcusweb/merchantapi/add 变更为https://test.allinpaygd.com/vsppcusapi/merchantapi/add 影响接口范围:商户信息管理旧版本接口(商户进件,商户审核状态查询,商户信息查询,商户信息修改,商户门店信息查询,商户门店新增,商户门店修改,商户终端查询、商户终端新增)、商户信息管理新版本接口(商户进件,商户状态查询,商户信息查询,商户基本信息修改,商户门店信息,商户产品信息,商户终端信息)、无纸化进件相关接口(无纸化进件协议状态查询,无纸化进件协议重发接口,无纸化进件电子协议URL接口查询)、活动报名相关接口(商户活动报名,活动状态查询)、渠道能力相关接口(微信子商户配置,渠道子商户查询,移动支付非标渠道报备,微信发放代金券) ●2020.03.19 1. 进件接口新增字段picurljson -图片链接json 2. 大版本更新,3.商户信息管理接口(新版本)对旧版本2.商户信息管理接口(旧版本)编辑接口进行修改,独立出门店、产品接口并对异步回调通知响应优化 建议合作方尽快按新版本3.商户信息管理接口改造,原旧版本接口不再维护,但不停用 3. 身份证证件类型非身份证的 不校验图片OCR 4. 新增6.5微信代发代金券api ●2019.11.20 1. 2.1进件接口新增无纸化标识字段agreetype,已申请开通电子协议的合作方可通过该字段对其拓展的子商户选择是否走电子协议 2. 2.1进件接口同步返回新增合作方商户号字段merchantid 2. 新增2.14无纸化进件电子协议URL查询接口queryelecturl 3. 新增4.3渠道子商户号查询接口(querychnlcmid),支持微信与支付宝子商户号查询,旧接口4.2微信子商户号查询接口(querywxcmid)两个月后会删除 4. 新增4.4移动支付非标渠道报备接口,此接口需申请开通权限方可访问 ●2019.10.24 1.进件、编辑、查询信息接口新增渠道备注字段(选填) 2.编辑接口新增开通终端类产品商户必填字段 ●2019.09.04 新增2.15微信子商户号查询接口(暂只支持测试环境使用,9月11日后更新至生产环境) ●2019.08.17 2.1进件接口增加legalphone法人手机号码字段,该字段在申请电子协议模式下为必填字段 2.4结果通知增加edittype编辑子类型 新增2.11无纸化进件协议签约状态查询接口 新增2.12无纸化进件协议重发接口 新增2.13无纸化进件协议签约通知接口 ●2019.07.17 活动报名接口地址变更为https://vsp.allinpay.com/activity/cusactivity,原接口地址https://vsp.allinpay.com/merchantapi/cusactivity地址将于2019年8月14日停止使用 活动状态接口地址变更为https://vsp.allinpay.com/activity/queryactivity 原接口地址https://vsp.allinpay.com/merchantapi/queryactivity 地址将于2019年8月14日停止使用。 ●2019.03.13 进件接口新增offlag线上线下业务场景字段 ●2019.01.04 增加支持终端类商户进件,门店、终端类相关API接口 ●2018.12.19 编辑接口新增zipurl字段 用于补充附件 ●2018.11.21 新增蓝海绿洲活动报名api 新增活动报名状态查询 ●2018.10.24 新增接口增加结算人身份证号字段 查询返回新增三个状态 ●2018.09.19 进件接口新增legalidtype枚举,支持港澳台证件 修改接口增加开户所在省市字段 ●2018.08.15 进件增加所属父客户字段,合作方资金归集时该字段不能为空 ●2018.07.18 新增VSP551 银联扫码交易类型,商户进件产品信息新增creditrate 信用卡费率字段 ●2018.06.25 修改商户进件状态查询为商户状态查询(新增除API进件外,该合作方下所属商户状态查询) 修改进件成功商户信息查询为商户信息查询(新增除API进件外,该合作方下所属商户信息) 商户信息修改增加至可修改该合作方下所属商户 ●2018.05.08 新增商户信息修改接口 ●2018.04.01 营业执照照片在个人商户性质时可为空 增加“经营场所证明文件”及“其他审核材料”的文件上送要求 创建 ●2018.04.01
yinjr
2025年2月20日 23:08
转发文档
收藏文档
上一篇
下一篇
手机扫码
复制链接
手机扫一扫转发分享
复制链接
Markdown文件
Word文件
PDF文档
PDF文档(打印)
分享
链接
类型
密码
更新密码
有效期