Close Order
Update Time:2025.01.07The 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.
|
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
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. | transaction_id | string(32) | Choose one | Path WeChat order No. corresponding to the original payment transaction |
Merchant order No. | out_trade_no | string(32) | Path Order No. corresponding to the original payment transaction | |
Merchant ID | mchid | string(32) | Yes | Body Merchant ID assigned by WeChat Pay |
Sub-merchant ID | sub_mchid | string(32) | Yes | Body Merchant ID assigned to sub-merchants by WeChat Pay |
Institution's Merchant ID | sp_mchid | string(32) | Yes | Body Institution's Merchant ID assigned by WeChat Pay |
Request Example
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. | |||
|
Response Example:
SUCCESS
ERROR
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. |