最新更新時間：2021.12.22 版本說明
以下情況需要調用關單接口：商戶訂單支付失敗需要生成新單號重新發(fā)起支付，要對原訂單號調用關單，避免重復支付；系統(tǒng)下單后，用戶支付超時，系統(tǒng)退出不再受理，避免用戶繼續(xù)，請調用關單接口。
適用對象：直連商戶
請求URL： https://api.mch.weixin.qq.com/pay/closeorder
URL地址： https://api2.mch.weixin.qq.com/pay/closeorder(備用域名)見跨城冗災方案
請求方式： POST
數(shù)據格式： XML
是否需要證書： 否
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 公眾賬號ID | appid | string[1,32] | 是 | 微信分配的公眾賬號ID（企業(yè)號corpid即為此appid） 示例值：wx8888888888888888 |
| 商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值：1900000109 |
| 商戶訂單號 | out_trade_no | string[1,32] | 是 | 商戶系統(tǒng)內部訂單號，要求32個字符內，只能是數(shù)字、大小寫字母_-|*@ ，且在同一個商戶號下唯一。 示例值：1217752501201407033233368018 |
| 隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串，不長于32位。推薦隨機數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,32] | 是 | 簽名，詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 簽名類型 | sign_type | string[1,32] | 否 | 簽名類型，目前支持HMAC-SHA256和MD5，默認為MD5 示例值：HMAC-SHA256 |
<xml>
<appid>wx8888888888888888</appid>
<mch_id>1900000109</mch_id>
<out_trade_no>1217752501201407033233368018</out_trade_no>
<nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
<sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
</xml>
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 返回狀態(tài)碼 | return_code | string[1,16] | 是 | SUCCESS/FAIL 此字段是通信標識，非交易標識，交易是否成功需要查看trade_state來判斷 示例值：SUCCESS |
| 返回信息 | return_msg | string[1,128] | 否 | 當return_code為FAIL時返回信息為錯誤原因 ，例如 簽名失敗 參數(shù)格式校驗錯誤 示例值：簽名失敗 |
以下字段在return_code為SUCCESS的時候有返回
| 參數(shù)名 | 變量 | 類型 | 必填 | 描述 |
|---|---|---|---|---|
| 公眾賬號ID | appid | string[1,32] | 是 | 微信分配的公眾賬號ID 示例值：wx8888888888888888 |
| 商戶號 | mch_id | string[1,32] | 是 | 微信支付分配的商戶號 示例值：1900000109 |
| 隨機字符串 | nonce_str | string[1,32] | 是 | 隨機字符串，不長于32位。推薦隨機數(shù)生成算法 示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS |
| 簽名 | sign | string[1,32] | 是 | 簽名，詳見簽名生成算法 示例值：C380BEC2BFD727A4B6845133519F3AD6 |
| 業(yè)務結果 | result_code | string[1,16] | 是 | SUCCESS/FAIL 示例值：SUCCESS |
| 業(yè)務結果描述 | result_msg | string[1,16] | 是 | 對業(yè)務結果的補充說明 示例值：OK |
| 錯誤代碼 | err_code | string[1,32] | 否 | 當result_code為FAIL時返回錯誤代碼，詳細參見下文錯誤列表 示例值：SYSTEMERROR |
| 錯誤代碼描述 | err_code_des | string[1,128] | 否 | 當result_code為FAIL時返回錯誤描述，詳細參見下文錯誤列表 示例值：系統(tǒng)錯誤 |
<xml>
<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>
| 名稱 | 描述 | 解決方案 |
|---|---|---|
| SYSTEMERROR | 接口返回錯誤 | 請嘗試再次掉調用API。 |
| REFUNDNOTEXIST | 退款訂單查詢失敗 | 請檢查訂單號是否有誤以及訂單狀態(tài)是否正確，如：未支付、已支付未退款 |
| INVALID_TRANSACTIONID | 無效transaction_id | 請求參數(shù)錯誤，檢查原交易號是否存在或發(fā)起支付交易接口返回失敗 |
| PARAM_ERROR | 參數(shù)錯誤 | 請求參數(shù)錯誤，請檢查參數(shù)再調用退款申請 |
| APPID_NOT_EXIST | APPID不存在 | 請檢查APPID是否正確 |
| MCHID_NOT_EXIST | MCHID不存在 | 請檢查MCHID是否正確 |
| REQUIRE_POST_METHOD | 請使用post方法 | 請檢查請求參數(shù)是否通過post方法提交 |
| SIGNERROR | 簽名錯誤 | 請檢查簽名參數(shù)和方法是否都符合簽名算法要求 |
| XML_FORMAT_ERROR | XML格式錯誤 | 請檢查XML參數(shù)格式是否正確 |