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

Sub Merchant Query API

Latest update time:2020.12.25 Release notes


Query the entry status of sub merchants


API Intro

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

Request method:POST

Certificate Requirements:Yes certificate is required.

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
Sub-Merchant ID sub_mch_id string(32) Yes Specifies the sub merchant ID by WeChat
Example:1230000109

Example:


<xml>  
   <app_id>wx2421b1c4370ec43b</app_id>
   <mch_id>1230000109</mch_id>
   <sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
   <sub_mch_id>1230000109</sub_mch_id>
</xml> 
						
    
{
JAVA示例代码
}
    

Return Data

Name ID Type Required Description
Returned status code return_code string(16) Yes SUCCESS/FAIL
This field is used as a communication identifier instead of a transaction identifier. Whether the transaction is successful shall be determined by checking result_code.
Example:SUCCESS
Returned message return_msg string(128) No Returned message. If shall present the cause of an error if not null.
Signature failed
Parameter format verification error
Example:Signature failed

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
Error Code err_code String(32) No Error code
Example:INVALID_REQUEST
Error Code Description err_code_des String(128) No Detailed description of error code
Example:Sub merchant information error, please check and retry
Signature sign string(32) Yes Specifies a signature.
Example:C380BEC2BFD727A4B6845133519F3AD6
Sub_mch_id sub_mch_id string(32) Yes Specifies the sub merchant ID assigned by WeChat.
Example:013467007045764
Merchant Name merchant_name string(50) Yes Specifies the complete company entity name .
Example:ABC Merchant
Abbreviated Company Name merchant_shortname string(20) Yes Specifies the brief name of the merchant, which will be shown to the consumers.
Example:ABC
Registered Country or Region merchant_country_code string(3) No The country where the company was registered, see to  CountryCode
Example:ABC
Business Category business_category string(10) Yes Specifies the business category, please refer to the Business Category list of WeChat payment.
Example:101
MCC mcc string(4) No Mcc code, see to MCC code
Example:075586010000
Office Telephone No. office_phone string(20) Yes Specifies the customer service phone number, which will be shown in the payment details page for the consumers.
Example:075586010000
Full Name contact_name string(32) No Specifies the contact person’s name.
Example:Eric Lee
Mobile  Phone No. contact_phone string(16) No Specifies the mobile phone number of the merchant for any urgent issues.
Example:13000000000
Email contact_email string(128) No Specifies the contact email of the merchant.
Example:test@test.com
Merchant remark merchant_remark string(20) Yes The information annotated by the institution for the merchant. The code created by the institution for the merchant can be used.
Example:ABC1234567
Business type business_type string(7) No There are three business types: ONLINE,
OFFLINE or BOTH
Example:BOTH
Merchant Type merchant_type string(10) No ENTERPRISE or INDIVIDUAL
Example:ENTERPRISE
Registration Certificate Number registration_certificate_number string(50) No Company registration document Number.
Example:5555-8888
Expiration Date of Registration Certificate registration_certificate_date string(10) 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 
Example:2020-10-16
Download link of APP app_download string(128) No The download link of merchant’s APP.
Example:https://download.qq.com
Business website business_website string(128) No The business website url
Example:https://www.qq.com
Official account office_account string(128) No Merchant’s official account.
Example:wx8888888888888888
Mini Program mini_program string(128) No Merchant’s mini program.
Example:wx8888888888888888
Store address store_address string(128) No Store address.
Example:10F World Finance Centre (South Office), 11 Canton Road, Tsim Sha Tsui, Hong Kong
Director Name director_name string(128) No Director name.
Example:Bob Zhang
Director ID Number director_id_number string(128) No Director's ID number.
Example:5555-8888
Principal Name principal_name string(128) No Principal name.
Example:Bob Zhang
Principal ID Number principal_id_number string(128) No Principal's ID number.
Example:5555-8888
Settlement Bank No. settlement_bank_number string(128) No Settlement bank account number (settlement bank information)
Example:555588889999
Channel ID channel_id string(32) No Get from WeChat business platform(pay.wechat.com/cn)
Example:12343234

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> 
   <merchant_name><![CDATA[ABC Merchant]]></merchant_name> 
   <merchant_shortname><![CDATA[ABC]]></merchant_shortname> 
   <merchant_country_code><![CDATA[344]]></merchant_country_code> 
   <business_category><![CDATA[101]]></business_category>
   <mcc><![CDATA[4214]]></mcc>
   <office_phone><![CDATA[075586010000]]></office_phone> 
   <contact_name><![CDATA[Eric Lee]]></contact_name>
   <contact_phone><![CDATA[13000000000]]></contact_phone> 
   <contact_email><![CDATA[test@xxx.com]]></contact_email>  
   <merchant_remark><![CDATA[ABC1234567]]></merchant_remark> 
</xml> 
								  

Release notes

关闭
V1.0
2020.12.25
1. StepAdded fileds including merchant_country_code, mcc, business_type, merchant_type, registration_certificate_number, registration_certificate_date, app_download, business_website, office_account, mini_program, store_address, director_name, director_name, principal_name, principal_name, settlement_bank_number and channel_id.
2. Deleted fileds including website_$n, merchant_introduction_$n and total
V1.0
2019.12.22
1. Sub Merchant Query 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