Query Domain Modification Application
Update Time:2025.01.07This API is used to Query Domain Modification Application.
|
1. API Intro
Applicable object: Institutional mode Service Provider Mode
API rules:https://apihk.mch.weixin.qq.com/v3/global/merchant/h5/permission/domain/applications/{applyment_id}
Request method:GET
Path parameter is a path parameter.
Query parameter needs to be passed in the request URL.
Body parameter needs to be passed in the request JSON.
2. Request Parameters
Name | Variable Name | Type | Required | Description |
---|---|---|---|---|
Request ID | applyment_id | int | Yes | Path Unique ID of the request. |
Request example
URL
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. |
Sub-merchant's website status | website_state | string | Yes | The status of the sub-merchant's website. Valid values: |
Web payment domain | domains | array | Yes | The domain that pulls web payment. |
Sub-merchant's website URL | webiste_url | string[1, 128] | Yes | The URL of the website on which the sub-merchant's business categories, products/services and prices are displayed and users can place orders. |
Website business page screenshot | website_business_page_pics | array | No | This field is required when the website is not launched. The value is a media ID, which can be obtained via the image upload API |
Website homepage screenshot | website_homepage_pics | array | No | This field is required when the website is not launched. The value is a media ID, which can be obtained via the image upload API |
Application ID | applyment_id | int | Yes | Unique ID of the H5 authorization application. |
Rejection reason | audit_reject_detail | string[1, 500] | No | The reason why the request is rejected. |
Request status | applyment_state | string | No | The status of the web payment domain modification request. Valid values: |
Callback API provided by merchants to receive review results | notify_url | string[1, 128] | No | The HTTPS protocol is required. If the URL cannot be accessed, the merchant will not receive any WeChat notifications. The notification URL must be directly accessible without any parameters. |
Merchant request ID | out_applyment_id | string[6, 32] | Yes | Internal request ID in the merchant system. The request ID can only contain numbers, letters, underscores (_), hyphens (-), and asterisks (*), and is unique under the same merchant ID. |
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 | No | It is returned when code is PARAM_ERROR. Details will be described below. | |||
|
Response Example:
SUCCESS
ERROR
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 | PARAM_ERROR | The request number does not exist. Check and try again. | The request number does not exist. Check and try again. |