關(guān)閉訂單
應用場景
以下情況需要調(diào)用關(guān)單接口：商戶訂單支付失敗需要生成新單號重新發(fā)起支付，要對原訂單號調(diào)用關(guān)單，避免重復支付；系統(tǒng)下單后，用戶支付超時，系統(tǒng)退出不再受理，避免用戶繼續(xù)，請調(diào)用關(guān)單接口。
注意：訂單生成后不能馬上調(diào)用關(guān)單接口，最短調(diào)用時間間隔為5分鐘。接口地址
https://apihk.mch.weixin.qq.com/pay/closeorder （建議接入點：東南亞）
https://apius.mch.weixin.qq.com/pay/closeorder （建議接入點：其它）
https://api.mch.weixin.qq.com/pay/closeorder （建議接入點：中國國內(nèi)）
注：商戶可根據(jù)實際請求情況選擇最優(yōu)域名進行訪問，建議在接入時做好兼容，當訪問其中一個域名出現(xiàn)異常時，可自動切換為其他域名。
是否需要證書
不需要。
請求參數(shù)
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公眾賬號ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號ID（企業(yè)號corpid即為此appId） |
| 商戶號 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號 |
| 商戶訂單號 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號，要求32個字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個商戶號下唯一。 |
| 隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串，不長于32位。推薦隨機數(shù)生成算法 |
| 簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名，詳見簽名生成算法 |
| 簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型，目前支持HMAC-SHA256和MD5，默認為MD5 |
示例代碼
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>4ca93f17ddf3443ceabf72f26d64fe0e</nonce_str>
<out_trade_no>1415983244</out_trade_no>
<sign>59FF1DF214B2D279A0EA7077C54DD95D</sign>
</xml>
返回結(jié)果
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 返回信息 | return_msg | 否 | String(128) | 簽名失敗 | 返回信息，如非空，為錯誤原因 簽名失敗 參數(shù)格式校驗錯誤 |
以下字段在return_code為SUCCESS的時候有返回
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公眾賬號ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號ID |
| 商戶號 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號 |
| 隨機字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機字符串，不長于32位 |
| 簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名，驗證簽名算 |
| 業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 業(yè)務(wù)結(jié)果描述 | result_msg | 是 | String(32) | OK | 對于業(yè)務(wù)執(zhí)行的詳細描述 |
| 錯誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 詳細參見第6節(jié)錯誤列表 |
| 錯誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)錯誤 | 結(jié)果信息描述 |
示例代碼
<xml>
<return_code><![CDATA[SUCCESS]]></return_code>
<return_msg><![CDATA[OK]]></return_msg>
<appid><![CDATA[wx2421b1c4370ec43b]]></appid>
<mch_id><![CDATA[10000100]]></mch_id>
<nonce_str><![CDATA[BFK89FC6rxKCOjLX]]></nonce_str>
<sign><![CDATA[72B321D92A7BFA0B2509F3D13C7B1631]]></sign>
<result_code><![CDATA[SUCCESS]]></result_code>
<result_msg><![CDATA[OK]]></result_msg>
</xml>
錯誤碼
| 名稱 | 描述 | 原因 | 解決方案 |
|---|---|---|---|
| ORDERPAID | 訂單已支付 | 訂單已支付，不能發(fā)起關(guān)單 | 訂單已支付，不能發(fā)起關(guān)單，請當作已支付的正常交易 |
| SYSTEMERROR | 系統(tǒng)錯誤 | 系統(tǒng)錯誤 | 系統(tǒng)異常，請重新調(diào)用該API |
| ORDERCLOSED | 訂單已關(guān)閉 | 訂單已關(guān)閉，無法重復關(guān)閉 | 訂單已關(guān)閉，無需繼續(xù)調(diào)用 |
| SIGNERROR | 簽名錯誤 | 參數(shù)簽名結(jié)果不正確 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| REQUIRE_POST_METHOD | 請使用post方法 | 未使用post傳遞參數(shù) | 請檢查請求參數(shù)是否通過post方法提交 |
| XML_FORMAT_ERROR | XML格式錯誤 | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |