关闭订单

更新时间：2024.11.14

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

注意：

订单生成后不能马上调用关单接口，最短调用时间间隔为5分钟。

接口说明

适用对象：服务商

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

URL地址： https://api2.mch.weixin.qq.com/pay/closeorder(备用域名)见跨城冗灾方案

请求方式： POST

数据格式： XML

是否需要证书：否

请求参数

参数名	变量	类型	必填	描述
服务商的APPID	appid	string[1,32]	是	服务商商户的APPID 示例值：wx8888888888888888
商户号	mch_id	string[1,32]	是	微信支付分配的商户号示例值：1900000109
子商户公众账号ID	sub_appid	string[1,32]	否	微信分配的子商户公众账号ID 示例值：wx8888888888888888
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
商户订单号	out_trade_no	string[1,32]	是	商户系统内部订单号，要求32个字符内（最少6个字符），只能是数字、大小写字母_-\|*且在同一个商户号下唯一。详见商户订单号示例值：1217752501201407033233368018
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位。推荐随机数生成算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,32]	否	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6

请求示例：

XML

1<xml>
2  <appid>wx8888888888888888</appid>
3  <mch_id>10000100</mch_id>
4  <sub_mch_id>wx8888888888888888</sub_mch_id>
5  <nonce_str>5K8264ILTKCH16CQ2502SI8ZNMTM67VS</nonce_str>
6  <out_trade_no>1217752501201407033233368018</out_trade_no>
7  <sign>C380BEC2BFD727A4B6845133519F3AD6</sign>
8</xml>

返回参数

参数名	变量	类型	必填	描述
返回状态码	return_code	string[1,16]	是	SUCCESS/FAIL 示例值：SUCCESS
返回信息	return_msg	string[1,128]	否	返回信息，如非空，为错误原因如：签名失败等。示例值：签名失败

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

参数名	变量	类型	必填	描述
服务商的APPID	appid	string[1,32]	是	服务商商户的APPID 示例值：wx8888888888888888
商户号	mch_id	string[1,32]	是	微信支付分配的商户号示例值：1900000109
子商户公众账号ID	sub_appid	string[1,32]	否	微信分配的子商户公众账号ID 示例值：wx8888888888888888
子商户号	sub_mch_id	string[1,32]	是	微信支付分配的子商户号示例值：1900000109
随机字符串	nonce_str	string[1,32]	是	随机字符串，不长于32位，推荐随机数生成算法示例值：5K8264ILTKCH16CQ2502SI8ZNMTM67VS
签名	sign	string[1,32]	是	签名，详见签名生成算法示例值：C380BEC2BFD727A4B6845133519F3AD6
业务结果	result_code	string[1,16]	是	SUCCESS/FAIL 示例值：SUCCESS
业务结果描述	result_msg	string[1,16]	是	对业务结果的补充说明示例值：OK
错误代码	err_code	string[1,32]	否	当result_code为FAIL时返回错误代码，详细参见下文错误列表示例值：SYSTEMERROR
错误代码描述	err_code_des	string[1,128]	否	当result_code为FAIL时返回错误代码，详细参见下文错误列表示例值：系统错误

返回示例：

正常示例

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   <sub_mch_id><![CDATA[1900000109]]></sub_mch_id>  
7   <nonce_str><![CDATA[BFK89FC6rxKCOjLX]]></nonce_str>   
8   <sign><![CDATA[72B321D92A7BFA0B2509F3D13C7B1631]]></sign>   
9   <result_code><![CDATA[SUCCESS]]></result_code> 
10   <result_msg><![CDATA[OK]]></result_msg>
11</xml>

错误码

名称	描述	解决方案
SYSTEMERROR	接口返回错误	请尝试再次掉调用API。
REFUNDNOTEXIST	退款订单查询失败	请检查订单号是否有误以及订单状态是否正确，如：未支付、已支付未退款
INVALID_TRANSACTIONID	无效transaction_id	请求参数错误，检查原交易号是否存在或发起支付交易接口返回失败
PARAM_ERROR	参数错误	请求参数错误，请检查参数再调用退款申请
APPID_NOT_EXIST	APPID不存在	请检查APPID是否正确
MCHID_NOT_EXIST	MCHID不存在	请检查MCHID是否正确
REQUIRE_POST_METHOD	请使用post方法	请检查请求参数是否通过post方法提交
SIGNERROR	签名错误	请检查签名参数和方法是否都符合签名算法要求
XML_FORMAT_ERROR	XML格式错误	请检查XML参数格式是否正确

文档是否有帮助

更多支持

开发文档(商户)开发文档(V2版)开发者社区微信开放平台微信公众平台腾讯客服