商户接口进件
最后更新日期:2023.10.30
1. 产品介绍
1.1 简介
汇付提供控台和接口两种进件模式,此文档为渠道商、平台商户给商户进件接口版。控台进件模式另见操作文档;
拥有商户进件权限的角色:
渠道商:支持进件平台商户、商户、门店;
平台商户:支持进件商户、门店;
支持的商户进件类型:
- 渠道商:支持进件平台商户、商户、门店;
- 平台商户:支持进件商户、门店;
1.2 应用场景
渠道商、平台商户需要批量为商户进件时,可使用接口进件,效率更高。
2. 接入前准备
2.1 商务准备
- 商户进件流程
【商户准入】→【填写基本信息】→【配置结算信息】→【配置支付功能】→【选择协议类型】→【提交审核】
- 商户进件信息填写项说明
- 基本信息
商户身份 | 基础信息 | 营业执照 | 法人信息 | 个人信息 | 经营信息 | 联系人信息 | 账号信息 |
---|---|---|---|---|---|---|---|
企业商户 | √ | √ | √ | × | √ | √ | √ |
小微商户 | √ | × | × | √ | √ | × | √ |
- 准备材料
企业进件材料:👈
材料类型
|
名称
|
文件类型
|
说明 |
---|---|---|---|
基础材料 | 营业执照 | F07型 | 请提供原件照片或加盖鲜章的复印件,图片内容清晰,放大后可完整识别统一社会信用代码。 |
基础材料 | 法人身份证国徽面 | F03型 | 请提供原件照片或加盖鲜章的复印件,图片内容清晰,法人证件姓名需与营业执照姓名保持一致。 |
基础材料 | 法人身份证人像面 | F02型 | 请提供原件照片或加盖鲜章的复印件,图片内容清晰,法人证件姓名需与营业执照姓名保持一致。 |
基础材料 | 店铺门头照 | F22型 | 有固定门店的需提供,要求招牌清晰可见; |
基础材料 | 店铺内景照 | F24型 | 经营照片或流动经营/便民服务现场照片; |
基础材料 | 店铺收银台照 | F105型 | 商户线下场景需要提供 |
线上支付材料 | 公司前台照 | F478型 | 开通线上支付需补充材料 |
线上支付材料 | 工作区域内景照 | F371型 | 开通线上支付需补充材料 |
对公结算材料 | 对公账户证明 | F08型 | 包括开户许可证/基本存款账户信息/电子回单/印鉴卡等 |
对私法人结算材料 | 结算银行卡 | F13型 | 请提供原件照片或加盖鲜章的复印件,图片内容清晰。附件可出现“办理POS收款业务”等字样,但严禁出现其他品牌的信息。 |
对私非法人结算材料 | 结算银行卡 | F13型 | 请提供原件照片或加盖鲜章的复印件,图片内容清晰。附件可出现“办理POS收款业务”等字样,但严禁出现其他品牌的信息。 |
对私非法人结算材料 | 结算人身份证国徽面 | F56 | 要求同法人身份证照 |
对私非法人结算材料 | 结算人身份证国徽面 | F55 | 要求同法人身份证照 |
对私非法人结算材料 | 授权委托书 | F15 | 要求非法人结算的需提供授权委托书,下载模板 |
补充材料 | 补充材料 | 开通其它业务功能需要补充的材料,参见说明 |
个体工商户进件材料:👈
|
|
|
|
---|---|---|---|
党政、机关及事业单位材料:👈
|
|
|
|
---|---|---|---|
其他组织材料:👈
|
|
|
|
---|---|---|---|
注:上表中【文件类型】是调用【图片接口】上传材料时需要填写的值,详见取值说明。
- 业务信息
业务项 | 企业商户 | 小微商户 | ||
---|---|---|---|---|
线下场所 | 线上平台 | 线下场所 | 线上平台 | |
绑定银行卡 | √ | √ | √ | √ |
结算配置 | √ | √ | √ | √ |
微信支付 | √ | √ | √ | √ |
支付宝支付 | √ | √ | √ | √ |
银联二维码支付 | √ | √ | √ | √ |
POS刷卡支付 | √ | × | × | × |
多方分账 | √ | √ | × | √ |
手动取现 | √ | √ | √ | √ |
余额支付 | √ | √ | × | × |
补贴支付 | √ | √ | × | × |
快捷支付 | × | √ | × | × |
网银支付 | × | √ | × | × |
手机WAP支付 | × | √ | × | × |
银行大额转账 | × | √ | × | × |
代发 | × | √ | × | × |
全域资金 | × | √ | × | × |
其他配置 | √ | √ | √ | √ |
补充业务信息 | × | √ | × | √ |
2.2 对接准备
第一步:密钥获取
联调之前需要先获取公私钥,参见公私解钥参数获取说明;
第二步:公共参数获取
登录服务商/商户控台后,可在开发设置-开发者信息中,获取sys_id,product_id参数信息;
第三步:渠道商权限配置
保证渠道商已开通了相应的商户进件所需要的业务功能及支付权限。
3. 开发指引
3.1 对接规范
调用汇付接口,均采取POST形式提交,数据格式统一为JSON格式,相关SDK及签名方法见链接:
SDK示例:Java SDK
加签验签:v2版接口加签验签
3.2 系统调用流程
商户标准进件调用流程
标准进件流程分两步:先商户基本信息进件生成huifu_id,再通过商户业务开通做业务配置;
主要提供商户进件所需的信息,需要注意以下内容:
- 企业商户对私法人结算或对私非法人结算,如果选择纸质协议签约方式需要准备结算授权书;
- 电子协议签约会发签约短信给签约人。系统会对签约人至少做实名+手机号的验证,请正确填写签约人信息。
- 基本信息变更、业务功能、费率变更也可能会涉及变更协议。流程同上。
签约流程:
接口进件过程中涉及商户与汇付的签约操作。有三种签约方式可选择:
- 挂网协议方式:商户首次开通业务功能时,通过服务商提供的到端产品,向商户提供勾选确认页面,商户阅读指定地址的挂网协议内容,视为同意协议约定的内容。开通的业务功能及费率以系统内的配置为准。
- 首次进件开通业务选择挂网协议,后续如通过接口变更无需选择签约形式,无需再签约。
- 电子协议方式:斗拱系统会根据开通的业务功能及相关费率向指定的签约人发送电子协议签约短信。签约人可能是法人、银行结算账户的持有人或联系人。系统会自动对签约人及相关信息做必要的身份真实性验证,验证通过才发送电子协议。
- 纸质协议方式:商户需要将线下签好的纸质协议盖章上传到系统中。
- 企业商户调用 企业商户基本信息入驻 、小微商户调用 个人商户基本信息入驻 完成开户、绑卡、结算配置。 商户注册完成之后,如需要修改,可以调用 商户基本信息修改。
- 调用 商户业务开通 开通银行卡刷卡、银联二维码、支付宝、微信入驻。
- 涉及有审核异步通知时,审核完成之后,汇付会将审核异步消息推送至客户指定接受异步消息地址(async_return_url)。同时客户也可以调用 申请单状态查询 查询汇付申请单状态。
- 需要开通微信支付的商户,还要调用 微信商户配置、微信实名认证接口 完成信配置、实名认证。
客户调用接口中所需要资料文件都是填入汇付file_id,通过调用 商户图片上传 获取汇付file_id。
3.3 接口说明
3.3.1 标准商户进件
接口进件:调用接口【图片上传】【企业商户基本信息入驻】、【个人商户基本信息入驻】、【商户业务开通】
- 【图片上传】
用于上传进件所需要的各种材料。
参数 | 中文名 | 必填 | 说明 |
---|---|---|---|
file_type | 图片类型 | N | 按进件及变更接口中的要求上送文件类型。参见文件类型枚举; |
注意图片的大小不超过2M;
详见接口说明;
- 【企业商户基本信息入驻】
服务商通过此接口在汇付为企业类商户进行基本信息开户。传入企业商户基本资料和图片资料,开通汇付账号,为商户绑定银行卡、配置结算和取现等功能。若选择发送短信给商户,汇付将会以短信方式发送账号、密码、控台地址至商户联系人手机号。
- 【个人商户基本信息入驻】服务商通过此接口在汇付为个人类商户进行基本信息开户。传入个人商户基本资料和图片资料,开通汇付账号,为商户绑定银行卡、配置结算和取现等功能。若选择发送短信给商户,将会发送账号、密码、控台地址短信至商户联系人手机号。
- 【商户业务开通】
已完成基本信息入驻的商户可根据具体业务需求调用此接口为商户开通微信、支付宝、银联二维码、银行卡、快捷支付、网银支付等支付业务。 传入商户资料及对应的业务参数,为商户开通需使用的支付业务。
- 开通微信(支持多费率通道)、支付宝、银联二维码、银行卡等线下业务时在接口中配置交易费率;
- 开通快捷支付、网银支付等线上业务时打开对应业务权限、配置交易费率。
- 支持一次调用开通多项业务;
- 首次未开通的业务可再次调用此接口进行业务补开。业务开通时可能需要提供以下材料:
- 纸质协议:如果协议类型选择纸质协议,需要上传盖章后的协议文本扫描件;
- 行业相关的补充材料:
- 如果开通了快捷、网银、余额支付、分账功能必须填写线上业务业型编码【online_busi_type】,根据选择编码提供相应的补充材料,参见线上业务类型编码及补充材料说明;
- 如果开通快捷、网银、余额支付、分账、银行大额转账需提供运营媒介材料,包括:首页、服务/商品明细页面、下单场景页、支付页。
- 功能相关的补充材料:
- 如果开通了余额支付需要按业务情况说明【description_info】字段做相应的说明。另外提供相应的证明材料,参见开通余额支付补充材料;
- 如果要开通分账功能参见商户分账配置接口;
注意:
- 为商户开通业务的渠道商自身要开通相应的业务权限。比如渠道商未开通银行卡业务,则也不能为下属商户开通银行卡业务;
- 【商户分账配置】
开通分账功能:
- 需要按业务情况说明【split_ext_info】字段做相应的说明。
- 提供相应的证明材料,参见分账功能提供材料说明;
- 分账功能会涉及签约,系统会按前一次签约方式(挂网/电子/纸质)与商户进行变更签约操作。
3.3.2 标准商户变更
- 接口进件:调用接口【商户基本信息修改】、【商户业务开通修改】、【商户AT入驻信息修改】
- 【商户基本信息修改】
已完成基本信息入驻的商户若信息填写有误或需变更,调用此接口。支持商户的基本信息、银行卡信息、结算和取现配置信息的变更。
- 如果修改结算卡信息【card_info】会发送短信验证码给原结算人。原结算人要提供验证码证明已知晓结算卡变更事宜,斗拱会校验验证码;
- 结算费率、取现费率修改会触发协议签约流程。其它修改不涉及签约。
- 【商户业务开通修改】
已完成业务开通的商户若信息填写有误或需变更,用此接口修改企业&小微商户业务信息。支持:
- 商户微信、支付宝业务补开;(银联、银行卡业务开通仍通过商户业务开通接口)
- 快捷支付、网银、手机网页支付等线上业务的开通;
- 修改商户微信、支付宝、银联二维码、银行卡、快捷、网银、手机网页等业务的交易费率;
注意:
- 涉及费率修改的都需要走协议变更流程。
- 需要提供的补充材料规则参考商户业务开通接口;
- 【商户AT入驻信息修改】
仅对已完成AT(支付宝/微信)入驻的商户,可以调用此接口对其在微信支付宝的信息进行修改,可支持批量。
3.3.3 其它接口
- 【申请单状态查询】
商户进件、基本信息变更、业务开通、业务变更都会生成申请单进入审核流程。这些接口异步会返回审核结果。如果长时间未收到异步结果也可以通过申请单状态查询接口获取流程状态。接口支持查询商户各种已提交的申请单,包括商户业务开通申请单、活动报名申请单、信息修改申请单等,若申请单审核拒绝,将返回拒绝的详细原因,可根据拒绝原因修改信息。
4. API列表
- 标准商户进件类
类型
|
接口名称
|
描述 |
---|---|---|
API | 商户图片上传 | 提供商户图片上传服务。 |
API | 企业商户基本信息入驻 | 服务商通过此接口在汇付为企业类商户进行基本信息开户。传入企业商户基本资料和图片资料,开通汇付账号,为商户绑定银行卡、配置结算和取现等功能。若选择发送短信给商户,汇付将会以短信方式发送账号、密码、控台地址至商户联系人手机号。 |
API | 个人商户基本信息入驻 | 服务商通过此接口在汇付为个人类商户进行基本信息开户。传入个人商户基本资料和图片资料,开通汇付账号,为商户绑定银行卡、配置结算和取现等功能。若选择发送短信给商户,将会发送账号、密码、控台地址短信至商户联系人手机号。 |
API | 商户业务开通 | 商户进件成功后开通支付方式、业务功能、配置费率;会触发签约流程。 |
API | 商户基本信息变更 | 已完成基本信息入驻的商户若信息填写有误或需变更,调用此接口。支持商户的基本信息、银行卡信息、结算和取现配置信息的变更。 |
API | 商户业务修改 | 修改商户的业务配置,包括支付方式、业务功能、手续费率,可能会触发签约流程。 |
应用程序接口 | 商户详细信息查询 | 商户获取到汇付商户号后,可使用此接口查询商户信息。支持查询商户基本信息、业务开通信息(线上&线下)、银行卡绑卡信息、结算和取现配置信息。 |
应用程序接口 | 商户AT入驻信息修改 | 已完成AT入驻的商户,可以调用此接口对其在微信支付宝的信息进行修改,可支持批量。目前支持对于简称和客服电话的修改。 |
应用程序接口 | 申请单状态查询 | 申请单提交后,调用此接口查询商户申请单审核状态及各业务开通结果。支持查询商户各种已提交的申请单,包括商户业务开通申请单、活动报名申请单、信息修改申请单等,若申请单审核拒绝,将返回拒绝的详细原因,可根据拒绝原因修改信息。 |
应用程序接口 | 商户分账配置 | 为商户设置默认分账规则、分账费率等,会触发签约流程。 |
应用程序接口 | 商户分账配置查询 | 查询商户默认的分账配置。 |
- 商户进件H5页面版接口
类型 |
接口名称
|
描述 |
---|---|---|
应用程序接口 | 商户统一进件(页面版) | 接口返回H5进件页面,后面封装了商户进件流程。一次调用解决商户进件、支付功能开通、微信支付宝入驻。 |
应用程序接口 | 统一进件页面版查询 | 通过门店号查询商户统一进件(页面版)进件的商户的状态; |
5.常见问题
更多问题详见斗拱开发者社区:https://service.dougong.net/t/qa