API Dictionary / H5 Payment Authorization Application / Query Authorization Status

Query Authorization Status

Latest update time：2024.01.25 Release notes

This API is used to query the web payment authorization status of a sub-merchant.

Note：

• Due to product iteration, the H5 payment authorization can be applied for using the Merchant Onboarding interface.

• For more information, please refer to:
Merchant Onboarding（Introduction）
Merchant Onboarding（Preparation）
Merchant Onboarding（Development Guidelines）
Merchant Onboarding（APIs）

1. API Intro

Applicable object： Institutional mode Service Provider Mode

API rules：https://apihk.mch.weixin.qq.com/v3/global/merchant/h5/permission/{sub_mchid}

Request method：GET

Pathparameter is a path parameter.

Queryparameter needs to be passed in the request URL.

Bodyparameter needs to be passed in the request JSON.

2. Request Parameters

Name	Variable Name	Type	Required	Description
Sub-merchant ID	sub_mchid	string[1, 32]	Yes	Path ID of a sub-merchant under the current institution/service provider. Example：2491935631

Request example

URL


https://api.mch.weixin.qq.com/v3/global/merchant/h5/permission/2491935631

{
    "appid": "wx2421b1c4370ec43b"
}


									{
										"stock_id": ".NET",
									}


									{
										"stock_id": "Python",
									}

3. Response Parameters

Response for a successful request

Name	Variable Name	Type	Required	Description
Sub-merchant ID	sub_mchid	string[1, 32]	Yes	ID of the sub-merchant under the current institution/service provider. Example：2491935631
Web payment authorization status	authorization_state	string	Yes	Web payment authorization status of the sub-merchant. Valid values: AUTHORITY_TO_TEST: Authorized with an ultra-low limit FORMAL_AUTHORITY: Authorized with an ordinary limit AUTHORIZED: Authorized with no limit UNDER_PUNISHMENT: Sub-merchant under penalty UNAUTHORIZED: Unauthorized Example：AUTHORITY_TO_TEST

Response for failed request:

Name

Variable Name

Type

Required

Description

Returned status code

code

string[1,32]

Yes

Error code. See the error code list for the enumerated values.

Returned information

message

string[1,256]

Yes

Returned message. It indicates the reason for the error if not empty.

Detailed error description

detail

object

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

Name	Variable Name	Type	Required	Description
The location of incorrect parameter	field	string[1,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.
Value of the incorrect parameter	value	string[1,256]	Yes	Value of the incorrect parameter
Cause of error	issue	string[1,256]	Yes	Cause of error
Location of the incorrect parameter	location	string[1,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

pack up

Response Example:

SUCCESS ERROR

{
  "authorization_state": "AUTHORITY_TO_TEST",
  "sub_mchid": "2491935631"
}

 
{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "与ALLOF schema不符",
		"location": "body"
	}
}

4. Error Codes

Error Codes	Error Message	Description	Solution
500	SYSTEM_ERROR	System error	Call the API again later with the same parameters.
429	FREQUENCY_LIMIT_EXCEED	Frequency limit, please try it later	Frequency limit, please try it later
400	INVALID_REQUEST	The parent-child relationship is invalid. Check if the sub-merchant belongs to the service provider.	The parent-child merchant relationship cannot be established. Please verify and try again.

Page Navigation

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Payments

Funding Products

Other Products

Query Authorization Status

1. API Intro

2. Request Parameters

Request example

3. Response Parameters

Response for a successful request

Response for failed request:

Response Example:

4. Error Codes