關(guān)閉訂單API
最新更新時間：2023.10.20 版本說明
以下情況需要調(diào)用關(guān)單接口：商戶訂單支付失敗需要生成新單號重新發(fā)起支付，要對原訂單號調(diào)用關(guān)單，避免重復(fù)支付；系統(tǒng)下單后，用戶支付超時，系統(tǒng)退出不再受理，避免用戶繼續(xù)，請調(diào)用關(guān)單接口。
注意：? 訂單生成后不能馬上調(diào)用關(guān)單接口，最短調(diào)用時間間隔為5分鐘。
注意：1. 接口說明
適用對象:直連模式機構(gòu)模式
請求URL:https://apihk.mch.weixin.qq.com/v3/global/transactions/id/{transaction_id}/close
或
https://apihk.mch.weixin.qq.com/v3/global/transactions/out-trade-no/{out_trade_no}/close
請求方式: POST
Path指該參數(shù)為路徑參數(shù)
Query指該參數(shù)為URL參數(shù)
Body指該參數(shù)需在請求JSON傳參
2. 請求參數(shù)
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 微信支付訂單號 | transaction_id | string[1,32] | 二選一 | Path 微信支付訂單號 示例值：1217752501201407033233368018 |
| 商戶訂單號 | out_trade_no | string[1,32] | Path 商戶訂單號 示例值：1217752501201407033233368018 |
|
| 商戶號 | mchid | string[1,32] | 是 | Body 微信支付分配的商戶號 注意：僅適用于直連模式 示例值：1900000109 |
| 子商戶號 | sub_mchid | string[1,32] | 是 | Body 微信支付分配的子商戶號 注意：僅適用于機構(gòu)模式 示例值：1900000109 |
| 機構(gòu)商戶號 | sp_mchid | string[1,32] | 是 | Body 微信支付分配的機構(gòu)商戶號 注意：僅適用于機構(gòu)模式 示例值：1900000100 |
請求示例
{
"sp_mchid": "10000100",
"sub_mchid": "20000100"
}
3. 返回參數(shù)
正常返回
無數(shù)據(jù)(HTTP狀態(tài)碼為204)
異常返回
| 參數(shù)名 | 變量 | 類型[長度限制] | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | code | string[1, 32] | 是 | 錯誤碼，枚舉值見錯誤碼列表 示例值：INVALID_REQUEST |
| 返回信息 | message | string[1, 256] | 是 | 返回信息，如非空，為錯誤原因 示例值：參數(shù)格式校驗錯誤 |
| 詳細的錯誤描述 | detail | object | 否 | 當code為PARAM_ERROR時返回，詳細說明見下 |
返回示例
{
"code": "INVALID_REQUEST",
"message": "Parameter format verification error",
"detail": {
"field": "#/properties/payer",
"value": "1346177081915535577",
"issue": "與ALLOF schema不符",
"location": "body"
}
}
4. 錯誤碼
| 錯誤碼 | 描述 | 解決方案 |
|---|---|---|
| ORDERPAID | 訂單已支付 | 訂單已支付，不能發(fā)起關(guān)單，請當作已支付的正常交易 |
| SYSTEM_ERROR | 系統(tǒng)錯誤 | 系統(tǒng)異常，請重新調(diào)用該API |
| ORDER_CLOSED | 訂單已關(guān)閉 | 訂單已關(guān)閉，無需繼續(xù)調(diào)用 |
| REQUIRE_POST_METHOD | 請使用post方法 | 請檢查請求參數(shù)是否通過post方法提交 |
頁面導(dǎo)航
