最新更新時(shí)間：2020.10.10 版本說(shuō)明
以下情況需要調(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)單接口。
適用對(duì)象：直連商戶 服務(wù)商
請(qǐng)求URL： https://api.mch.weixin.qq.com/pay/closeorder
冗災(zāi)備用URL：https://api2.mch.weixin.qq.com/pay/closeorder(備用域名)見(jiàn)跨城冗災(zāi)方案
請(qǐng)求方式： POST
數(shù)據(jù)格式： XML
是否需要證書： 否
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值：wx8888888888888888 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值：1900000109 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務(wù)商模式 示例值：wx8888888888888888 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意：僅適用于服務(wù)商模式 示例值：1900000109 |
| 商戶訂單號(hào) | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內(nèi)部訂單號(hào)，要求32個(gè)字符內(nèi)，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個(gè)商戶號(hào)下唯一。 示例值：1217752501201407033233368018 |
| 隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,64] | 是 | 簽名，詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
<xml>
<appid>wx2421b1c4370ec43b</appid>
<mch_id>10000100</mch_id>
<nonce_str>ec2316275641faa3aacf3cc599e8730f</nonce_str>
<transaction_id>1008450740201411110005820873</transaction_id>
<sign>FDD167FAA73459FD921B144BAF4F4CA2</sign>
</xml>
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標(biāo)識(shí)，非交易標(biāo)識(shí)，交易是否成功需要查看result_code來(lái)判斷 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 返回信息，如非空，為錯(cuò)誤原因 簽名失敗 參數(shù)格式校驗(yàn)錯(cuò)誤 示例值：簽名失敗 |
返回狀態(tài)碼(return_code)為SUCCESS的時(shí)候,包含以下字段
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 應(yīng)用ID | appid | string[1,32] | 是 | 微信分配的應(yīng)用ID 示例值：wx8888888888888888 |
| 商戶號(hào) | mch_id | string[1,32] | 是 | 微信支付分配的商戶號(hào) 示例值：1900000109 |
| 子商戶應(yīng)用ID | sub_appid | string[1,32] | 否 | 微信分配的子商戶應(yīng)用ID，如需在支付完成后獲取sub_openid則此參數(shù)必傳。 注意：僅適用于服務(wù)商模式 示例值：wx8888888888888888 |
| 子商戶號(hào) | sub_mch_id | string[1,32] | 是 | 微信支付分配的子商戶號(hào) 注意：僅適用于服務(wù)商模式 示例值：1900000109 |
| 隨機(jī)字符串 | nonce_str | string[1,32] | 是 | 隨機(jī)字符串，不長(zhǎng)于32位。推薦隨機(jī)數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,64] | 是 | 簽名，詳見(jiàn)簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 業(yè)務(wù)結(jié)果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 錯(cuò)誤代碼 | err_code | string[1,32] | 否 | 詳細(xì)參見(jiàn)錯(cuò)誤列表 示例值：SYSTEMERROR |
| 錯(cuò)誤代碼描述 | err_code_des | string[1,128] | 否 | 結(jié)果信息描述 示例值：系統(tǒng)錯(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)單，請(qǐng)當(dāng)作已支付的正常交易 |
| SYSTEMERROR | 系統(tǒng)錯(cuò)誤 | 系統(tǒng)異常，請(qǐng)重新調(diào)用該API |
| ORDERCLOSED | 訂單已關(guān)閉 | 訂單已關(guān)閉，無(wú)需繼續(xù)調(diào)用 |
| SIGNERROR | 簽名錯(cuò)誤 | 請(qǐng)檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| REQUIRE_POST_METHOD | 請(qǐng)使用post方法 | 請(qǐng)檢查請(qǐng)求參數(shù)是否通過(guò)post方法提交 |
| XML_FORMAT_ERROR | XML格式錯(cuò)誤 | 請(qǐng)檢查XML參數(shù)格式是否正確 |