关闭订单

更新时间:2025.02.20

以下情况需要调用关单接口:商户订单支付失败需要生成新单号重新发起支付,要对原订单号调用关单,避免重复支付;系统下单后,用户支付超时,系统退出不再受理,避免用户继续,请调用关单接口。

接口说明

适用对象: 直连模式 机构模式

请求URL: https://apihk.mch.weixin.qq.com/pay/closeorder

请求方式: POST

是否需要证书:

请求参数

参数名

变量名

类型

必填

描述

公众账号ID

appid

string(32)

微信分配的公众账号ID`
示例值:wx8888888888888888

商户号

mch_id

string(32)

微信支付分配的商户号
示例值:1900000109

子商户公众账号ID

sub_appid

string(32)

微信分配的子商户公众账号ID
注意:仅适用于机构模式
示例值:wx8888888888888888

子商户号

sub_mch_id

string(32)

微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109

商户订单号

out_trade_no

string(32)

商户系统内部的订单号
示例值:1217752501201407033233368018

随机字符串

nonce_str

string(32)

随机字符串,不长于32位。推荐随机数生成算法
示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS

签名

sign

string(64)

签名,详见签名生成算法
示例值:C380BEC2BFD727A4B6845133519F3AD6

签名类型

sign_type

string(32)

签名类型,目前支持HMAC-SHA256和MD5,默认为MD5
示例值:HMAC-SHA2566

举例如下:

XML
1<xml>
2   <appid>wx2421b1c4370ec43b</appid>  
3   <mch_id>10000100</mch_id>
4   <nonce_str>4ca93f17ddf3443ceabf72f26d64fe0e</nonce_str>
5   <out_trade_no>1415983244</out_trade_no>
6   <sign>59FF1DF214B2D279A0EA7077C54DD95D</sign>
7</xml>

返回结果

字段名

变量名

类型

必填

描述

返回状态码

return_code

string(16)

SUCCESS/FAIL
示例值:SUCCESS

返回信息

return_msg

string(128)

返回信息,如非空,为错误原因
签名失败
参数格式校验错误
示例值:签名失败

以下字段在return_code为SUCCESS的时候有返回

字段名

变量名

类型

必填

描述

公众账号ID

appid

string(32)

微信分配的公众账号ID
示例值:wx8888888888888888

商户号

mch_id

string(32)

微信支付分配的商户号
示例值:1900000109

子商户公众账号ID

sub_appid

string(32)

微信分配的子商户公众账号ID
注意:仅适用于机构模式
示例值:wx8888888888888888

子商户号

sub_mch_id

string(32)

微信支付分配的子商户号
注意:仅适用于机构模式
示例值:1900000109

随机字符串

nonce_str

string(32)

随机字符串,不长于32位
示例值:5K8264ILTKCH16CQ2502SI8ZNMTM67VS

签名

sign

string(64)

签名,详见签名生成算法
示例值:C380BEC2BFD727A4B6845133519F3AD6

业务结果

result_code

string(16)

SUCCESS/FAIL
示例值:SUCCESS

业务结果描述

result_msg

string(32)

对于业务执行的详细描述
示例值:OK

错误代码

err_code

string(32)

详细参见下文错误列表
示例值:SYSTEMERROR

错误代码描述

err_code_des

string(128)

结果信息描述
示例值:系统错误

举例如下:

XML
1<xml>
2   <return_code><![CDATA[SUCCESS]]></return_code>
3   <return_msg><![CDATA[OK]]></return_msg>
4   <appid><![CDATA[wx2421b1c4370ec43b]]></appid>
5   <mch_id><![CDATA[10000100]]></mch_id>
6   <nonce_str><![CDATA[BFK89FC6rxKCOjLX]]></nonce_str>
7   <sign><![CDATA[72B321D92A7BFA0B2509F3D13C7B1631]]></sign>
8   <result_code><![CDATA[SUCCESS]]></result_code>
9   <result_msg><![CDATA[OK]]></result_msg>
10</xml>

错误码

名称

描述

原因

解决方案

ORDERPAID

订单已支付

订单已支付,不能发起关单

订单已支付,不能发起关单,请当作已支付的正常交易

SYSTEMERROR

系统错误

系统错误

系统异常,请重新调用该API

ORDERNOTEXIST

订单不存在

订单系统不存在此订单

不需要关单,当作未提交的支付的订单

ORDERCLOSED

订单已关闭

订单已关闭,无法重复关闭

订单已关闭,无需继续调用

SIGNERROR

签名错误

参数签名结果不正确

请检查签名参数和方法是否都符合签名算法要求

REQUIRE_POST_METHOD

请使用post方法

未使用post传递参数 

请检查请求参数是否通过post方法提交

XML_FORMAT_ERROR

XML格式错误

XML格式错误

请检查XML参数格式是否正确

 

 

About  WeChat  Pay

Powered By Tencent & Tenpay Copyright©

2005-2025 Tenpay All Rights Reserved.

Contact Us
Wechat Pay Global

WeChat Pay Global

Contact Us

Customer Service Tel

+86 571 95017

9:00-18:00 Monday-Friday GMT+8

Business Development

wxpayglobal@tencent.com

Developer Support

wepayTS@tencent.com

Wechat Pay Global

About Tenpay
Powered By Tencent & Tenpay Copyright© 2005-2025 Tenpay All Rights Reserved.