關(guān)閉訂單
應(yīng)用場(chǎng)景
以下情況需要調(diào)用關(guān)單接口：商戶訂單支付失敗需要生成新單號(hào)重新發(fā)起支付，要對(duì)原訂單號(hào)調(diào)用關(guān)單，避免重復(fù)支付；系統(tǒng)下單后，用戶支付超時(shí)，系統(tǒng)退出不再受理，避免用戶繼續(xù)，請(qǐng)調(diào)用關(guān)單接口。
注意：訂單生成后不能馬上調(diào)用關(guān)單接口，最短調(diào)用時(shí)間間隔為5分鐘。接口地址
接口鏈接：https://api.mch.weixin.qq.com/pay/closeorder
URL地址：https://api2.mch.weixin.qq.com/pay/closeorder(備用域名)見跨城冗災(zāi)方案
是否需要證書
不需要。
請(qǐng)求參數(shù)
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公眾賬號(hào)ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號(hào)ID（企業(yè)號(hào)corpid即為此appid） |
| 商戶號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號(hào) |
| 商戶訂單號(hào) | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)（最少6個(gè)字符），只能是數(shù)字、大小寫字母_-|*且在同一個(gè)商戶號(hào)下唯一。詳見商戶訂單號(hào) |
| 隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 |
| 簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名，詳見簽名生成算法 |
| 簽名類型 | sign_type | 否 | String(32) | HMAC-SHA256 | 簽名類型，目前支持HMAC-SHA256和MD5，默認(rèn)為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 此字段是通信標(biāo)識(shí)，非交易標(biāo)識(shí)，交易是否成功需要查看trade_state來(lái)判斷 |
| 返回信息 | return_msg | 是 | String(128) | OK |
當(dāng)return_code為FAIL時(shí)返回信息為錯(cuò)誤原因 ，例如 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 |
以下字段在return_code為SUCCESS的時(shí)候有返回
| 字段名 | 變量名 | 必填 | 類型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公眾賬號(hào)ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公眾賬號(hào)ID |
| 商戶號(hào) | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商戶號(hào) |
| 隨機(jī)字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 |
| 簽名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 簽名，詳見簽名生成算法 |
| 業(yè)務(wù)結(jié)果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 業(yè)務(wù)結(jié)果描述 | result_msg | 是 | String(16) | OK | 對(duì)業(yè)務(wù)結(jié)果的補(bǔ)充說(shuō)明 |
| 錯(cuò)誤代碼 | err_code | 否 | String(32) | SYSTEMERROR | 當(dāng)result_code為FAIL時(shí)返回錯(cuò)誤代碼，詳細(xì)參見下文錯(cuò)誤列表 |
| 錯(cuò)誤代碼描述 | err_code_des | 否 | String(128) | 系統(tǒng)錯(cuò)誤 | 當(dāng)result_code為FAIL時(shí)返回錯(cuò)誤描述，詳細(xì)參見下文錯(cuò)誤列表 |
示例代碼
<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>
錯(cuò)誤碼
| 名稱 | 描述 | 原因 | 解決方案 |
|---|---|---|---|
| ORDERPAID | 訂單已支付 | 訂單已支付，不能發(fā)起關(guān)單 | 訂單已支付，不能發(fā)起關(guān)單，請(qǐng)當(dāng)作已支付的正常交易 |
| SYSTEMERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常，請(qǐng)重新調(diào)用該API |
| ORDERCLOSED | 訂單已關(guān)閉 | 訂單已關(guān)閉，無(wú)法重復(fù)關(guān)閉 | 訂單已關(guān)閉，無(wú)需繼續(xù)調(diào)用 |
| SIGNERROR | 簽名錯(cuò)誤 | 參數(shù)簽名結(jié)果不正確 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 未使用post傳遞參數(shù) | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過post方法提交 |
| XML_FORMAT_ERROR | XML格式錯(cuò)誤 | XML格式錯(cuò)誤 | 請(qǐng)檢查XML參數(shù)格式是否正確 |