Modify Authorization Application
Latest update time：2024.01.25 Release notes
This API is used to modify a rejected web payment authorization request.
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/applications/{applyment_id}
Request method：Patch
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 |
|---|---|---|---|---|
| Application ID | applyment_id | int | Yes | Path Unique ID of the H5 authorization application. Example: 100000 |
| Web payment domain | domains | array | Yes | Body The domain that pulls web payment. Example: ["qq.com"] |
| Company profile and business description | business_description | string[1, 500] | No | Body This field is required when NO_LIMIT is selected for transaction_limit_type. Example: Founded in November 1998, Tencent is an Internet-based platform company that uses technology to enrich the lives of Internet users and assist enterprises with digital upgrade. Our mission is "Value for Users, Tech for Good". |
| Limit type | transaction_limit_type | string | Yes | Body
Web payment limit type. Valid values: UN_LAUNCHED_WEBSITE_LIMIT: The payment limit for a website not launched. Limited Quota: ①1000 CNY/day/person if touched the transaction limit of the H5 payment, this customer couldn't pay to this sub-merchant through H5 channel on this day （re-accumulate in the next day） ② 50000 CNY/day/sub-merchant if touched the transaction limit of the H5 payment, this sub-merchant couldn't recevie money through H5 channel on this day（re-accumulate in the next day） NORMAL_LIMIT: The payment limit authorized when the information is incomplete. This value is used by default if this field is not specified. Limited Quota： ①50000 CNY/day/person,if touched the payment limit of the H5 payment limited quota, this customer couldn't pay to this sub-merchant through H5 channel on this day （re-accumulate in the next day） ② 500000 CNY/day/sub-merchant, if touched the payment limit of the H5 payment limited quota, this sub-merchant couldn't recevie money through H5 channel on this day （re-accumulate in the next day） NO_LIMIT: No payment limit. Example: UN_LAUNCHED_WEBSITE_LIMIT |
| Certificate of incorporation | company_register_cert | string[1, 128] | No | Body This field is required when NO_LIMIT is selected for transaction_limit_type. The value is a media ID, which can be obtained via the image upload API Example: 6uqyGjvHzOhsLleGFQVRF |
| Website business page screenshot | website_business_page_pics | array | No | Body 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 Example: ["6uqyGjvHzOhsLleGFQVRF"] |
| Website homepage screenshot | website_homepage_pics | array | No | Body 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 Example: ["6uqyGjvHzOhsLleGFQVRF"] |
| Sub-merchant's website status | website_state | string | No | Body The status of the sub-merchant's website. Valid values: HAS_LAUNCHED: The website has been launched. UN_LAUNCHED: The website is not launched. Example: HAS_LAUNCHED |
| Sub-merchant's website URL | website_url | string[1, 128] | No | Body The URL of the website on which the sub-merchant's business categories, products/services and prices are displayed and users can place orders. Example: https://qq.com |
Request example
{
"business_description": "Founded in November 1998, Tencent is an Internet-based platform company that uses technology to enrich the lives of Internet users and assist enterprises with digital upgrade.Our mission is "Value for Users, Tech for Good".",
"company_register_cert": "6uqyGjvHzOhsLleGFQVRF",
"domains": ["qq.com"],
"transaction_limit_type": "UN_LAUNCHED_WEBSITE_LIMIT",
"website_business_page_pics": ["6uqyGjvHzOhsLleGFQVRF"],
"website_homepage_pics": ["6uqyGjvHzOhsLleGFQVRF"],
"website_state": "HAS_LAUNCHED",
"website_url": "https://qq.com"
}
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 domain | domains | array | Yes | The domain that pulls web payment. Example: ["qq.com"] |
| Company profile and business description | business_description | string[1, 500] | No | This field is required when NO_LIMIT is selected for transaction_limit_type. Example: Founded in November 1998, Tencent is an Internet-based platform company that uses technology to enrich the lives of Internet users and assist enterprises with digital upgrade. Our mission is "Value for Users, Tech for Good". |
| Limit type | transaction_limit_type | string | Yes |
Web payment limit type. Valid values: UN_LAUNCHED_WEBSITE_LIMIT: The payment limit for a website not launched. Limited Quota: ①1000 CNY/day/person if touched the transaction limit of the H5 payment, this customer couldn't pay to this sub-merchant through H5 channel on this day （re-accumulate in the next day） ② 50000 CNY/day/sub-merchant if touched the transaction limit of the H5 payment, this sub-merchant couldn't recevie money through H5 channel on this day（re-accumulate in the next day） NORMAL_LIMIT: The payment limit authorized when the information is incomplete. This value is used by default if this field is not specified. Limited Quota： ①50000 CNY/day/person,if touched the payment limit of the H5 payment limited quota, this customer couldn't pay to this sub-merchant through H5 channel on this day （re-accumulate in the next day） ② 500000 CNY/day/sub-merchant, if touched the payment limit of the H5 payment limited quota, this sub-merchant couldn't recevie money through H5 channel on this day （re-accumulate in the next day） NO_LIMIT: No payment limit. Example: UN_LAUNCHED_WEBSITE_LIMIT |
| Certificate of incorporation | company_register_cert | string[1, 128] | No | This field is required when NO_LIMIT is selected for transaction_limit_type. Example: 6uqyGjvHzOhsLleGFQVRF |
| 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 Example: ["6uqyGjvHzOhsLleGFQVRF"] |
| 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 Example: ["6uqyGjvHzOhsLleGFQVRF"] |
| Sub-merchant's website status | website_state | string | Yes | The status of the sub-merchant's website. Valid values: HAS_LAUNCHED: The website has been launched. UN_LAUNCHED: The website is not launched. Example: HAS_LAUNCHED |
| Sub-merchant's website URL | website_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. Example: https://qq.com |
| Application ID | applyment_id | int | Yes | Unique ID of the H5 authorization application. Example: 100000 |
| Rejection reason | audit_reject_detail | string[1, 500] | No | The reason why the request is rejected. Example: The merchant's certificate does not meet requirements. |
| Request status | applyment_state | string | Yes | Web payment request status. Valid values: PENDING: The request is not created. Query again later or check whether the submission is normal. UNDER_REVIEW: The request is created and under review. APPROVED: The request is approved. REJECTED: The request is rejected. See audit_reject_detail for the rejection reason. Example: PENDING |
| Request type | applyment_type | string | Yes | Web payment request type. Valid values: APPLY_FOR_PAYMENT_AUTHORITY: The request for web payment authorization. APPLY_FOR_RELIEVE_LIMITED: The request for web payment limit removal. Example: APPLY_FOR_PAYMENT_AUTHORITY |
| 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. For more information, please refer to Authorization Result Notification Example: https://pay.weixin.qq.com/wxpay/pay.action |
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:
{
"applyment_id": 100000,
"applyment_state": "PENDING",
"applyment_type": "APPLY_FOR_PAYMENT_AUTHORITY",
"audit_reject_detail": "The merchant's certificate does not meet requirements.",
"business_description": "Founded in November 1998, Tencent is an Internet-based platform company that uses technology to enrich the lives of Internet users and assist enterprises with digital upgrade.Our mission is "Value for Users, Tech for Good".",
"company_register_cert": "6uqyGjvHzOhsLleGFQVRF",
"domains": ["qq.com"],
"notify_url": "https://pay.weixin.qq.com/wxpay/pay.action",
"sub_mchid": "2491935631",
"transaction_limit_type": "UN_LAUNCHED_WEBSITE_LIMIT",
"website_business_page_pics": ["6uqyGjvHzOhsLleGFQVRF"],
"website_homepage_pics": ["6uqyGjvHzOhsLleGFQVRF"],
"website_state": "HAS_LAUNCHED",
"website_url": "https://qq.com"
}
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 | When creating a request using this API, the limit type must be "No transaction limited". | The limit type needs to be "No transaction limited" when initiating a request to remove limits. |
| 400 | PARAM_ERROR | The website has not launched. Upload the business page screenshot. | Please re-initiate the call after uploading a screenshot of the business website. |
| 400 | INVALID_REQUEST | Unable to update the information when a request is not in the "Rejected" status | The application under review cannot be modified. Please wait for the rejection and then make the necessary changes. |
| 400 | INVALID_REQUEST | Only sub-merchants with the "Formal authority transaction limited" status can request to lift the limit. If sub-merchants with other statuses need to modify their authorization, they can call the "H5 payment authorization request" API. | Please apply for the H5 payment permission with a limit first before initiating the request to remove the limit. |
| 400 | INVALID_REQUEST | Action has been taken against the merchant. The merchant is not allowed to request to enable H5 payment authorization. | The payment authorization of the merchant has been penalized. Please contact the operation personnel to lift the penalty first. |
| 400 | INVALID_REQUEST | The submitted website or H5 payment domain name is at risk. Contact your BD for assistance. | The business website or H5 payment domain is blacklisted. Please contact the operation personnel to apply for an exemption. |
| 400 | PARAM_ERROR | The request number does not exist. Check and try again. | The request number does not exist. Check and try again. |
| 400 | PARAM_ERROR | The website has not launched. Upload the website homepage screenshot. | Please upload the screenshot of the homepage and try again. |
| 400 | INVALID_REQUEST | The website has not launched. You can request only a test limit. | Please select UN_LAUNCHED_WEBSITE_LIMIT as the limit type and try again. |
Page Navigation
