关闭订单

更新时间：2024.11.25

未支付状态的订单，可在无需支付时调用此接口关闭订单。常见关单情况包括：

用户在商户系统提交取消订单请求，商户需执行关单操作。
订单超时未支付（超出商户系统设定的可支付时间或下单时的time_expire支付截止时间），商户需进行关单处理。

接口说明

支持商户：【普通商户】

请求方式：【POST】/v3/pay/transactions/out-trade-no/{out_trade_no}/close

请求域名：【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点

　　　　　【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点，指引点击查看

请求参数

Header HTTP头参数

Authorization 　必填　string

请参考签名认证生成认证信息

Accept 　必填　string

请设置为application/json

Content-Type 　必填　string

请设置为application/json

path 路径参数

out_trade_no 　必填 string(32)

【商户订单号】商户下单时传入的商户系统内部订单号。

body 包体参数

mchid 　必填 string(32)

【商户号】商户下单时传入的商户号。

请求示例

POST

1curl -X POST \
2  https://api.mch.weixin.qq.com/v3/pay/transactions/out-trade-no/1217752501201407033233368018/close \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "mchid" : "1900000001"
8  }'

应答参数

204 No Content

无应答包体

应答示例

204 No Content

1'无应答包体'
2

错误码

公共错误码

状态码	错误码	描述	解决方案
400	PARAM_ERROR	参数错误	请根据错误提示正确传入参数
400	INVALID_REQUEST	HTTP 请求不符合微信支付 APIv3 接口规则	请参阅接口规则
401	SIGN_ERROR	验证不通过	请参阅签名常见问题
500	SYSTEM_ERROR	系统异常，请稍后重试	请稍后重试

业务错误码

状态码	错误码	描述	解决方案
400	INVALID_REQUEST	无效请求	请根据接口返回的详细信息检查
400	MCH_NOT_EXISTS	商户号不存在	请检查商户号是否正确，商户号获取方式请参考普通商户模式开发必要参数说明
401	SIGN_ERROR	签名错误	请检查签名参数和方法是否都符合签名算法要求，参考：如何生成签名
403	RULE_LIMIT	业务规则限制	因业务规则限制请求频率，请查看接口返回的详细信息
403	TRADE_ERROR	交易错误	因业务原因交易失败，请查看接口返回的详细信息
429	FREQUENCY_LIMITED	频率超限	请降低请求接口频率
500	SYSTEM_ERROR	系统错误	系统异常，请用相同参数重新调用

文档是否有帮助

更多支持

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