全部
在线测试
应用场景
以下情况需要调用关单接口：商户订单支付失败需要生成新单号重新发起支付，要对原订单号调用关单，避免重复支付；系统下单后，用户支付超时，系统退出不再受理，避免用户继续，请调用关单接口。
注意：订单生成后不能马上调用关单接口，最短调用时间间隔为 5 分钟。
接口地址
接口链接：https://api.mch.weixin.qq.com/pay/closeorder
URL 地址：https://api2.mch.weixin.qq.com/pay/closeorder(备用域名)见跨城冗灾方案
请求方式： POST
是否需要证书
不需要。
请求参数
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号 ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号 ID（企业号 corpid 即为此 appId） |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 商户订单号 | out_trade_no | 是 | String(32) | 1217752501201407033233368018 | 商户系统内部订单号，要求 32 个字符内，只能是数字、大小写字母_- |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于 32 位。推荐随机数生成算法 |
| 签名 | 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>
返回结果
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 返回状态码 | return_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL 此字段是通信标识，非交易标识，交易是否成功需要查看 trade_state 来判断 |
| 返回信息 | return_msg | 是 | String(128) | OK | 当 return_code 为 FAIL 时返回信息为错误原因 ，例如签名失败参数格式校验错误 |
以下字段在 return_code 为 SUCCESS 的时候有返回
| 字段名 | 变量名 | 必填 | 类型 | 示例值 | 描述 |
|---|---|---|---|---|---|
| 公众账号 ID | appid | 是 | String(32) | wx8888888888888888 | 微信分配的公众账号 ID |
| 商户号 | mch_id | 是 | String(32) | 1900000109 | 微信支付分配的商户号 |
| 随机字符串 | nonce_str | 是 | String(32) | 5K8264ILTKCH16CQ2502SI8ZNMTM67VS | 随机字符串，不长于 32 位。推荐随机数生成算法 |
| 签名 | sign | 是 | String(32) | C380BEC2BFD727A4B6845133519F3AD6 | 签名，详见签名生成算法 |
| 业务结果 | result_code | 是 | String(16) | SUCCESS | SUCCESS/FAIL |
| 业务结果描述 | result_msg | 是 | String(16) | OK | 对业务结果的补充说明 |
| 错误代码 | err_code | 否 | String(32) | 当 result_code 为 FAIL 时返回错误代码，详细参见下文错误列表 | |
| 错误代码描述 | err_code_des | 否 | String(128) | 当 result_code 为 FAIL 时返回错误描述，详细参见下文错误列表 |
示例代码
<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 | 订单已支付 | 订单已支付，不能发起关单 | 订单已支付，不能发起关单，请当作已支付的正常交易 |
| SYSTEMERROR | 系统错误 | 系统错误 | 系统异常，请重新调用该 API |
| ORDERCLOSED | 订单已关闭 | 订单已关闭，无法重复关闭 | 订单已关闭，无需继续调用 |
| SIGNERROR | 签名错误 | 参数签名结果不正确 | 请检查签名参数和方法是否都符合签名算法要求 |
| REQUIRE_POST_METHOD | 请使用 post 方法 | 未使用 post 传递参数 | 请检查请求参数是否通过 post 方法提交 |
| XML_FORMAT_ERROR | XML 格式错误 | XML 格式错误 | 请检查 XML 参数格式是否正确 |
| 有事情请找微信官方 谢谢！ |