Close Order API
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.
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. |
| 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 |
|
Response Example:
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"
}
}
