WeChat Pay Open Platform

API intro

Request URL:https://api.mch.weixin.qq.com/hk/v3/merchants/{sub_mchid}?sp_appid=parameter1&sp_mchid=parameter2

Request method: GET

Applicable object:Institutional mode

Certificate Requirements：Yes certificate is required.

API Rules: https://wechatpay-api.gitbook.io/wechatpay-api-v3

path This parameter needs to be set at the request URL

query This parameter needs to be set at the JSON for request body

Request Parameters

Name	Variable Name	Type	Required	Description
Institution's Merchant ID	sp_appid	string(32)	Yes	path Merchant ID assigned to institutions by WeChat Pay Note:Only forInstitutional mode Example：wx8888888888888888
Organization APPID	sp_mchid	string(32)	Yes	path APPID corresponding to the Service Account applied for by the institution on the WeChat Official Accounts Platform Note:Only forInstitutional mode Example：3200000001
Sub-merchant ID	sub_mchid	string(32)	Yes	path Sub-merchant ID Example：20000100

For example:

URL


https://api.mch.weixin.qq.com/hk/v3/merchants/{20000100}?sp_appid=wx8888888888888888&sp_mchid=1900000100

    
｛
JAVA示例代码
｝

Returned Result

Response for failed request:

Name

Variable Name

Type

Required

Description

Returned status code

code

string(32)

Yes

Error code. See the error code list for the enumerated values.
Example：INVALID_REQUEST

Returned message

message

string(256)

Yes

Returned message. It indicates the reason for the error if not empty.
Example：Parameter format verification error

+ Detailed error description

detail

object

No

It is returned when code is PARAM_ERROR. Details will be described below.

Name	Variable Name	Type	Required	Description
Location of the incorrect parameter	field	string(256)	Yes	If the incorrect parameter is in the JSON for request body, it is populated with the JSON Pointer pointing to this parameter. If the incorrect parameter is in the request URL or querystring, it is populated with the variable name of this parameter. Example：#/properties/payer
Value of the incorrect parameter	value	string(256)	Yes	Value of the incorrect parameter Example：1346177081915535577
Cause of error	issue	string(256)	Yes	Cause of error Example：It is different from ALLOF schema
Location of the incorrect parameter	location	string(256)	No	body：The incorrect parameter is in the JSON for request body url：The incorrect parameter is in the request URL query：The incorrect parameter is in the querystring of the request Example：body

Response for successful request

Name

Variable Name

Type

Required

Description

Submerchant id

sub_mchid

string(32)

Yes

Specifies the sub merchant ID assigned by WeChat
Example：20000100

Full name of the sub-merchant

name

string(128)

Yes

The registration name of the sub-merchant
Example：Merchant name

Short name of the sub-merchant

shortname

string(64)

Yes

The short name of the sub-merchant, which is used for the display of WeChat order details and the successful payment page
Example：Merchant shortname

Company contact information

office_phone

string(32)

Yes

Contact information of the merchant, which will be displayed to the user after the payment.
Example：075586010000

Registered Country or Region

merchant_country_code

string(3)

Yes

The country where the submerchant was registered ,see to CountryCode
Example：344

Business category

business_category

int

Yes

Specifies the business category, please refer to the business ID list of WeChat payment. Please see Business Category
Example：101

+ Contact information

contact

object

No

Contact information object details is listed below

Name	Variable Name	Type	Required	Description
Full Name	name	string(64)	No	Specifies the contact person’s name. Example：Bob Zhang
Mobile Phone No.	phone	string(32)	No	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	email	string(256)	No	Specifies the contact email of the merchant. Example：test@test.com

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

Settlement Bank No.

settlement_bank_number

string(128)

No

Settlement bank account number (settlement bank information)
Example：555588889999

+Business information

business

object

No

Business information, the detail is listed below

Name	Variable Name	Type	Required	Description
Business type	business_type	string(7)	No	There are three business types:ONLINE, OFFLINE or BOTH Example：BOTH
Download link of APP	app_download	string(128)	No	The download link of merchant’s APP. Example：https://download.qq.com
Business website	website	string(128)	No	The business website, app_download 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
MCC	mcc	string(4)	No	Mcc code, Please see Merchant category codes Example：4214

+ Director information

director

object

No

Director information,
The detail is listed below

Name	Variable Name	Type	Required	Description
Director Name	name	string(128)	No	Director name. Example：Bob
Director ID Number	number	string(128)	No	Director's ID number. Example：5555-8888

+ Principal information

principal

object

No

Principal information,
The detail is listed below

Name	Variable Name	Type	Required	Description
Principal Name	name	string(128)	No	Principal's ID number. Example：Bob
Principal ID Number	number	string(128)	No	Principal's ID number. Example：5555-8888

For example：

{
    "sub_mchid":"20000100",
	"name":"test mcherchan_name ",
	"shortname":"mcherchan_name",
	"office_phone":"075586010000",
	"merchant_country_code":"344",
	"business_category":101
}

{
"code":"INVALID_REQUEST",
"message":"Parameter format verification error",
"detail":{
    "field":"#/properties/payer",
    "value":"1346177081915535577",
    "issue":"It is different from ALLOF schema",
    "location":"body"
   }
}

Error Codes

Name	Description	Solution
PARAM_ERROR	Req param error	For the specific parameter format, please see the relevant document.
INVALID_REQUEST	Invaild request	Check your program based on the error message returned by the API.
SYSTEM_ERROR	System error please try again	System error. Re-initiate with the original parameters.
MCH_NOT_EXISTS	The sub_mchid Has not existed	After the Sub-merchant ID has been created for 5 minutes, call the Query API to confirm whether the creation is successful. If the sub-merchant does not exist, apply again.

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Onboarding Sub Merchant（For HK）

Query Sub-merchant API

Tips：

API intro

Request Parameters

For example:

Returned Result

Response for failed request:

Response for successful request

For example：

Error Codes

Release notes