Latest update time：2024.03.27 Release notes
Query the entry status of sub merchants
Request Url: https://api.mch.weixin.qq.com/secapi/mch/queryInstitutionsub
Request method:POST
Certificate Requirements：Yes certificate is required.
Applicable object:Institutional mode
| 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 |
<xml>
<app_id>wx2421b1c4370ec43b</app_id>
<mch_id>1230000109</mch_id>
<sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
<sub_mch_id>1230000109</sub_mch_id>
</xml> | 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(128) | Yes | Specifies the complete company entity name . Example：ABC Merchant |
| Abbreviated Company Name | merchant_shortname | string(64) | 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(32) | 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(64) | No | Specifies the contact person’s name. Example：Eric Lee |
| Mobile Phone No. | contact_phone | string(32) | No | Specifies the mobile phone number of the merchant for any urgent issues. Example：13000000000 |
| contact_email | string(256) | 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(20) | No | Get from WeChat business platform(pay.wechat.com/cn) Example：12343234 |
| H5 payment authorization state | h5_authorization_state | string(32) | No | Returned when apply_h5_payment is YES; describe the H5 payment authorization state of the sub-merchant: APPROVED: H5 payment authorization already granted; UNAUTHORIZED: H5 payment authorization not granted, no H5 authorization application submitted; UNDER_REVIEW: H5 payment authorization application is currently under review; REJECTED: H5 payment authorization application has been rejected, please check the reason for the rejection in h5_audit_reject_detail; UNDER_PUNISHMENT: H5 payment authorization has been applied and granted, but sub-merchant is currently being penalized; APPLICATION_FAILED: Failed to create the H5 payment authorization application, please check the reason in h5_audit_reject_detail. Example：APPROVED |
| H5 audit reject detail | h5_audit_reject_detail | string(1024) | No | Returned when H5 payment authorization state is REJECTED or APPLICATION_FAILED; reason for rejected or unsuccessful request. Example：Merchant certificate is invalid |
| Sub-merchant's status | sub_mch_status | string(32) | Yes | Sub-merchant's status refers to the status of the sub-merchant in the WeChat Pay system: OPERATING: Normal; the sub-merchant has normal payment authorization and can initiate transactions. PENDING: Pending; the sub-merchant's information has not passed regular review and the institution is required to log in to the WeChat Pay merchant platform to check and process it. The sub-merchant has normal payment authorization and can initiate transactions. DEACTIVATED: The sub-merchant has been deactivated; the institution has suspended the sub-merchant account and the sub-merchant has no payment authorization and cannot initiate any transaction. CLOSED: The sub-merchant has been closed; WeChat Pay has disabled the sub-merchant's payment authorization and the sub-merchant cannot initiate any transaction. INCOMPLETE_APPLICATION: Onboarding process is incomplete; sub-merchant's onboarding application is incomplete and has no payment authorization and cannot initiate any transaction. Please check the onboarding application status in the application_status field. Example: OPERATING |
| Sub-merchant's onboarding status | application_status | string(32) | No | Returned when the sub-merchant's onboarding status is: "INCOMPLETE_APPLICATION"; Sub-merchant onboarding application status: UNDER_REVIEW: Application is currently under review; WeChat Pay is reviewing the sub-merchant's onboarding application. Please wait. Check the sub-merchant's status every other day until it changes. REJECTED: It has been rejected; the sub-merchant's onboarding application has been rejected by WeChat Pay. Please check the reason for rejection in the application_rejected_detail field. Example: UNDER_REVIEW |
| Sub-merchant onboarding application rejection details | application_reject_detail | string(4096) | No | Returned when the sub-merchant's onboarding status is "REJECTED"; reason why the onboarding application is rejected by WeChat Pay reviewer; presented in json array format for every rejected field and the reason. If the application is rejected, please log in to the WeChat Pay Merchant Platform, modify the application information as required, and resubmit (API is not supported for now). Example：[{"field":"contact_name","reason":"contact name is invalid."},{"field":"contact_phone","reason":"contact phone is invalid."}] |
<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>
<h5_authorization_state><![CDATA[APPROVED]]></h5_authorization_state>
<sub_mch_status><![CDATA[OPERATING]]></sub_mch_status>
</xml>Customer Service Tel
Business Development
9:00-18:00
Monday-Friday GMT+8
Technical Support
WeChat Pay Global
ICP证