Login expired. Please log in again.

Feedback

0/300

Feedback

Submitted successfully

ok

Feedback

Network exception, please try again later

ok

Onborading Sub Merchant API

Access Guide
API Rules
Parameter Specifications
Public API
Onborading Sub Merchant
Sub Merchant Query
Sub Merchant Modifying
Help Center
Contact Us

Onborading Sub Merchant API

Latest update time:2020.12.04 Release notes


Entering the sub merchant information to the system.

API Intro

Request Url: https://api.mch.weixin.qq.com/secapi/mch/addInstitutionsub

Request method:POST

Certificate Requirements:Yes

Applicable object:Institutional mode

Parameter Settings

Name ID Type Required Description
Official Account ID app_id string(32) Yes Specifies Official Account ID assigned by WeChat
Example:wxd678efh567hg6787
Vendor ID mch_id string(32) Yes Specifies vendor ID assigned by WeChat Payment
Example:1230000109
Signature sign string(32) Yes Specifies a signature. For more information Signature Algorithm.
Example:C380BEC2BFD727A4B6845133519F3AD6
Channel ID channel_id string(32)   No Get from WeChat business platform(pay.wechat.com/cn)
Example:12343234
Merchant name merchant_name string(50) Yes Specifies the complete merchant entity name
Example:Fruit Store
Merchant shortname merchant_shortname string(20) Yes Specifies the brief merchant name, which will be shown to the consumers
Example:FS
Institution Merchant id merchant_remark string(20) Yes The unique merchant identification for the institution
Example:2020052501
Registered Country or Region merchant_country_code string(3) Yes The country where the company was registered, see to CountryCode
Example:344
Merchant Type merchant_type string(10) Yes ENTERPRISE or INDIVIDUAL
Example:ENTERPRISE
Business Category business_category string(3) Yes Specifies the business category, please refer to the business ID list of WeChat payment. see to Business Category
Example:344
MCC mcc string(4) Yes Mcc code, see to MCC code
Example:4214
Registration Certificate Number registration_certificate_number string(50) Yes/No Company registration document No. Required when Merchant Type is ENTERPRISE. Not required when Merchant Type is INDIVIDUAL
Example:5555-8888
Expiration Date of Registration Certificate registration_certificate_date string(10) Yes/No The expiration date of the company registration document.
The value should be expire date or “PERMANENT” , “N/A”, the date format should YYYY-MM-DD , such as 2020-10-16. Required when Merchant Type is ENTERPRISE. Not required when Merchant Type is INDIVIDUAL
Example:2020-10-16
Copy of Registration Certificate registration_certificate_copy string(128) No The photocopy of the company registration document.
The value should be the media ID returned by Uploading Image API.
Example:w7yQFawBtja5uEdm
Business type business_type string(7) Yes There are three business types: ONLINE,
OFFLINE or BOTH
Example:BOTH
Download link of APP app_download string(128) Yes/No The download link of merchant’s APP. app_download, bus_website,office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example:https://download.qq.com
Business website business_website string(128) Yes/No The business website, app_download, bus_website,office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example:https://www.qq.com
Official account office_account string(128) Yes/No Merchant’s official account. app_download, bus_website,office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example:wx8888888888888888
Mini Program mini_program string(128) Yes/No Merchant’s mini program. app_download, bus_website,office_account, mini_program choose one field to submit if business type is ONLINE or BOTH
Example:wx8888888888888888
Store address store_address string(128) Yes/No Store address, required if business type is OFFLINE or BOTH
Example:10F World Finance Centre (South Office), 11 Canton Road, Tsim Sha Tsui, Hong Kong
Store photos store_photos string(1024) No Store photos, required once business type is OFFLINE or BOTH. The value should be at least 3 media IDs, which is returned by Uploading Image API.
Multiple images are submitted in JSON format. Required if business type is OFFLINE or BOTH(Not mandatory)
Example:[Media_id1, Media_id2, Media_id3]
Director Name director_name string(128) No Director name. Specify this field only when the secondary merchant type is ENTERPRISE(Not mandatory).
Example:Bob Zhang
Director ID Number director_id_number string(128) No Director's ID number. Specify this field only when the secondary merchant type is ENTERPRISE.(Not mandatory).
Example:5555-8888
Principal Name principal_name string(128) No Principal name. Specify this field only when the secondary merchant type is INDIVIDUAL.(Not mandatory).
Example:Bob Zhang
Principal ID Number principal_id_number string(128) No Principal's ID number. Specify this field only when the secondary merchant type is INDIVIDUAL.(Not mandatory).
Example:5555-8888
Customer Service Phone Number. office_phone string(20) Yes Specifies the customer service phone number, which will be shown in the payment details page for the consumers.
Please prefix the phone number. See the appendix for prefixes.
Example:+86075586010000
Full Name contact_name string(32) Yes Specifies the contact person’s name.
Example:Bob Zhang
Mobile Phone No. contact_phone string(16) Yes Specifies the mobile phone number of the merchant for any urgent issues. Please prefix the phone number. See the appendix for prefixes.
Example:+8613633334444
Email contact_email string(128) Yes Specifies the contact email of the merchant.
Example:test@test.com
Settlement Bank No. settlement_bank_number string(128) No Settlement bank account number (settlement bank information)
Example:555588889999

Example:


<xml>
  <app_id>wx2421b1c4370ec43b</app_id>
  <mch_id>1230000109</mch_id>
  <sign>C47005DF5722D862EFF30E7B8964AE17</sign>
  <merchant_name>ABC Merchant</merchant_name>
  <merchant_shortname>ABC</merchant_shortname>
  <merchant_remark>202012041</merchant_remark>
  <merchant_country_code>036</merchant_country_code>
  <merchant_type>ENTERPRISE</merchant_type>
  <business_category>485</business_category>
  <mcc>4374</mcc>
  <registration_certificate_number>5555-8888</registration_certificate_number>
  <registration_certificate_date>2020-05-27</registration_certificate_date>
  <registration_certificate_copy>-x95m5iclsanHYauUt1</registration_certificate_copy>
  <business_type>BOTH</business_type>
  <mini_program>Flower Plus</mini_program>
  <store_address>First Street</store_address>
  <office_phone>+8602767883714</office_phone>
  <contact_name>bob</contact_name>
  <contact_phone>+8618688886666</contact_phone>
  <contact_email>test@163.com</contact_email>
  <settlement_bank_number>55558888</settlement_bank_number>
</xml>

    
{
JAVA示例代码
}
    

Return Data

Name ID Type Required Description
Return Status
Code
return_code string(16) Yes SUCCESS or FAIL
Specifies communicating label instead of
transaction label. The status of the
transaction is determined by the value of the
result_code field.
Example:SUCCESS
Return Data return_msg string(128) No If not empty, the returned info is the error
description.
Signature failure
Parameter format checking error
Example:Signature failure

If return_code is SUCCESS, return data will also include the following fields:


Name ID Type Required Description
Service Result result_code string(32) Yes SUCCESS/FAIL
Example:FAIL
Signature sign string(32) Yes Specifies a signature. For more information Signature Algorithm.
Example:C380BE7519F3AD6
Sub-Merchant ID sub_mch_id string(32) Yes Specifies the sub merchant ID by WeChat
Example:013467007045764
Error Code err_code string(32) No Please refer to the error code list
Example:INVALID_REQUEST
Error Code Description err_code_des string(128) No Describes result data
Example:System error

Example:


<xml> 
   <return_code><![CDATA[SUCCESS]]></return_code>     
   <return_msg><![CDATA[OK]]></return_msg>     
   <result_code><![CDATA[SUCCESS]]></result_code> 
   <sign><![CDATA[C380BEC2BFD727A4B6845133519F3AD6]]></sign>     
   <sub_mch_id><![CDATA[013467007045764]]></sub_mch_id>     
</xml>	

Release notes

关闭
V1.1
2020.12.04
1. Added fields including merchant_country_code, merchant_type, mcc, registration_certificate_number,registration_certificate_date, registration_certificate_copy, business_type, app_download, business_website, office_account, mini_program, store_address, store_photos, director_name, director_id_number, principal_name, principal_id_number, settlement_bank_number.
Deleted fileds including website and merchant_introduction
V1.0
2019.12.22
1. Onborading Sub Merchant API released online

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2019 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

Wechat Pay Global

ICP证

粤B1.B2-20090295