商戶接口進件
最后更新日期: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