API Dictionary / H5 Payment / Close Order API

Close Order API

Latest update time：2023.10.20 Release notes

The Close Order API should be called when a new order No. needs to be generated to initiate the payment again if the merchant order payment failed, to avoid duplicate payments. This API is also required when the order has been placed by the system but the user failed to pay in time, and the system exited automatically to stop the transaction.

Tips：

• The Close Order API cannot be called immediately after the order is generated. The minimum call interval is 5 minutes.

1. API intro

Applicable object: Common mode Institutional mode

Request URL:https://apihk.mch.weixin.qq.com/v3/global/transactions/id/{transaction_id}/close
OR
https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/{out_trade_no}/close

Request method: POST

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
WeChat Pay order No.	transaction_id	string(32)	Choose one	Path WeChat order No. corresponding to the original payment transaction Example: 1217752501201407033233368018
Merchant order No.	out_trade_no	string(32)	Choose one	Path Order No. corresponding to the original payment transaction Example: 1217752501201407033233368018
Merchant ID	mchid	string(32)	Yes	Body Merchant ID assigned by WeChat Pay Note: Only forCommon mode Example: 1900000109
Sub-merchant ID	sub_mchid	string(32)	Yes	Body Merchant ID assigned to sub-merchants by WeChat Pay Note: Only forInstitutional mode Example: 1900000109
Institution's Merchant ID	sp_mchid	string(32)	Yes	Body Institution's Merchant ID assigned by WeChat Pay Note: Only forInstitutional mode Example: 1900000100

Request Eample

JSON


{
    "sp_mchid": "10000100",
    "sub_mchid": "20000100"
}


https://apihk.mch.weixin.qq.com/v3/global/refunds?out_trade_no=1217752501201407033233368018&count=10&offset=0&sp_mchid=1900000100&sub_mchid=1900000109


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

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

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


No data (HTTP status code is 204)


{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "Not in line with ALLOF schema",
		"location": "body"
	}
}

4. Error Codes

Error Message	Description	Solution
ORDERPAID	Order paid	The order is paid and cannot be closed. Handle it as a normal paid transaction.
SYSTEM_ERROR	System error	System error. Call this API again.
ORDER_CLOSED	Order closed	The order is closed and this API cannot be called.
REQUIRE_POST_METHOD	Use post method.	Check whether the request parameter is submitted via post method.

Page Navigation

Language

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

Payments

Funding Products

Other Products

Close Order API

1. API intro

2. Request Parameters

Request Eample

3. Response Parameters

Response for successful request

Response for failed request:

Response Example:

4. Error Codes