Product Capability API Dictionary Interface Rules Access Specification FAQs Terms Update Log

Payments
- Quick Pay
- Native Payment
- JSAPI Payment
- In-App Payment
- Mini Program Payment
- H5 Payment
- Auto-Debit Payment
Funding Products
- Funds Distribution(Transaction)
- Funds Distribution(Operate)
- Funds Distribution(Refund)
- Funds Distribution(Bill and Fund)
Other Products
- Merchant Onboard
- H5 Payment Authorization Application
- Customs Declaration

Revoke Order

Update Time：2025.01.07

When a failure is returned from the payment transaction or the payment system times out, call the API to cancel the transaction. If the user of an order fails to pay, the WeChat Pay system will close the order. If the user pays successfully, the WeChat Pay system will refund the order amount to the user.

Tips：

This API can be called to cancel transaction orders within 7 days. For other normal paid orders, call the API for refund requests. After submitting payment transactions, call the [Order Query API]. Call the [Cancel Order API] if no payment result is shown.

Do not call the Cancel Order API immediately after calling the Payment API. It is recommended to call the Cancel Order API at least 15 seconds after payment.

1. API Intro

Applicable object： Common mode Institutional mode

Request URL：https://apihk.mch.weixin.qq.com/v3/global/micropay/transactions/id/{transaction_id}/reverse
Or
https://apihk.mch.weixin.qq.com/v3/global/micropay/transactions/out-trade-no/{out_trade_no}/reverse

Request method：POST

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
WeChat Pay order No.	id	string(32)	Choose One	Path WeChat Pay order No. Example: 1217752501201407033233368018
Merchant order No.	out_trade_no	string(32)	Choose One	Path The order No. in the merchant system with a length of not more than 32 characters, including letters. If the authorization code changes, a new merchant order No. must be used. For more information, see Merchant Order No. Example: 1217752501201407033233368018
Merchant ID	mchid	string(32)	Yes	Body Merchant ID assigned by WeChat Pay Note: Only for Common mode Example: 1900000109
Institution's Merchant ID	sp_mchid	string(32)	Yes	Body Institution's Merchant ID assigned by WeChat Pay Note: Only for Institutional mode Example: 1900000109
Sub-merchant ID	sub_mchid	string(32)	Yes	Body Sub-merchant ID assigned by WeChat Pay Note: Only for Institutional mode Example: 1900000100

Request Example：

Common mode

1{
2    "mchid": "10000100"
3}

Service Provide Mode/Institution Mode

1{
2    "sp_mchid": "10000100",
3    "sub_mchid": "20000100"
4}

3. Response Parameters

Response for successful request:

No data (HTTP status code is 204)

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.

Detailed error description

Response Example:

SUCCESS

1No data (HTTP status code is 204)

ERROR

1{
2	"code": "INVALID_REQUEST",
3	"message": "Parameter format verification error",
4	"detail": {
5		"field": "#/properties/payer",
6		"value": "1346177081915535577",
7		"issue": "与ALLOF schema不符",
8		"location": "body"
9	}
10}

4. Error Codes

Error Message	Description	Solution
SYSTEM_ERROR	Errors returned from the API	Call the Result View API of the scanned order immediately to view the current order status and decide the next step according to the status.
INVALID_TRANSACTIO NID	Invalid transaction_id	Invalid parameter. Check again.
PARAM_ERROR	Invalid parameter	Please check your program according to the details returned by the API.
REVERSE_EXPIRE	The order cannot be canceled.	Check whether the order to be canceled is within the cancel period.
INVALID_REQUEST	Invalid request	Check whether the merchant permissions are unusual and whether there are repeated payment requests, invalid certificate, rate limit, etc.
TRADE_ERROR	Order error	Check whether the user account is unusual, under risk control and in compliance with the rules.