API字典 / 付款码支付 / 撤销订单API

撤销订单

最新更新时间：2023.04.21 版本说明

支付交易返回失败或支付系统超时，调用该接口撤销交易。如果此订单用户支付失败，微信支付系统会将此订单关闭；如果用户支付成功，微信支付系统会将此订单资金退还给用户。

注意：

• 7天以内的交易单可调用撤销，其他正常支付的单如需实现相同功能请调用申请退款API。提交支付交易后调用【查询订单API】，没有明确的支付结果再调用【撤销订单API】。

• 调用支付接口后请勿立即调用撤销订单API，建议支付后至少15s后再调用撤销订单接口。

1. 接口说明

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

请求URL：https://apihk.mch.weixin.qq.com/v3/global/micropay/transactions/id/{transaction_id}/reverse
或
https://apihk.mch.weixin.qq.com/v3/global/micropay/transactions/out-trade-no/{out_trade_no}/reverse

请求方式：POST

频率限制:150qps

Path指该参数为路径参数

Query指该参数为URL参数

Body指该参数需在请求JSON传参

2. 请求参数

参数名	变量	类型[长度限制]	必填	描述
商户号	mchid	string(32)	是	Body 微信支付分配的商户号注意：仅适用于直连模式示例值：1900000109
机构商户号	sp_mchid	string(32)	是	Body微信支付分配给机构的商户号注意：仅适用于机构模式示例值：1900000100
子商户号	sub_mchid	string(32)	是	Body 微信支付分配子商户的商户号注意：仅适用于机构模式示例值：1900000109
微信订单号	transaction_id	string(32)	二选一	Path 原支付交易对应的微信订单号示例值：1217752501201407033233368018
商户订单号	out_trade_no	string(32)	二选一	Path 原支付交易对应的订单号示例值：1217752501201407033233368018

请求示例

机构模式直连模式


{
    "sp_mchid": "10000100",
    "sub_mchid": "20000100"
}


{
    "mchid": "10000100"
}


									{
										"stock_id": ".NET",
										"limit": 10,
									}


									{
										"stock_id": "Python",
										"stock_creator_mchid": "123456",
										"limit": 10,
									}

3. 返回参数

正常返回

无数据(HTTP状态码为204)

异常返回

参数名

变量

类型[长度限制]

必填

描述

返回状态码

code

string[1, 32]

是

错误码，枚举值见错误码列表
示例值：INVALID_REQUEST

返回信息

message

string[1, 256]

是

返回信息，如非空，为错误原因
示例值：参数格式校验错误

详细的错误描述

detail

object

否

当code为PARAM_ERROR时返回，详细说明见下

参数名	变量	类型[长度限制]	必填	描述
指示错误参数的位置	field	string[1, 256]	是	当错误参数位于请求body的JSON时，填写指向参数的JSON Pointer 当错误参数位于请求的url或者querystring时，填写参数的变量名示例值：#/properties/payer
错误参数的值	value	string[1, 256]	是	错误参数的值示例值：1346177081915535577
具体错误原因	issue	string[1, 256]	是	具体错误原因示例值：与ALLOF schema不符
错误参数的位置	location	string[1, 256]	否	body：错误参数位于请求body的JSON中 url：错误参数位于请求url中 query：错误参数位于请求的querystring中示例值：body

收起

返回示例

正常示例异常示例


204
（无内容返回）


{
	"code": "INVALID_REQUEST",
	"message": "Parameter format verification error",
	"detail": {
		"field": "#/properties/payer",
		"value": "1346177081915535577",
		"issue": "与ALLOF schema不符",
		"location": "body"
	}
}

4. 错误码

错误码	描述	解决方案
SYSTEM_ERROR	接口返回错误	请立即调用被扫订单结果查询API，查询当前订单状态，并根据订单的状态决定下一步的操作。
BIZERR_NEED_RETRY	无效transaction_id	参数错误，请重新检查
PARAM_ERROR	参数错误	请根据接口返回的详细信息检查您的程序
REVERSE_EXPIRE	订单无法撤销	请检查需要撤销的订单是否超过可撤销有效期
INVALID_REQUEST	无效请求	请检查商户权限是否异常、重复请求支付、证书错误、频率限制等
TRADE_ERROR	订单错误	请检查用户账号是否异常、被风控、是否符合规则限制等

语言

页面导航

WeChat Pay

Feedback

Feedback

Submitted successfully

Feedback

Network exception, please try again later

支付产品

资金类产品

其他产品

撤销订单

1. 接口说明

2. 请求参数

请求示例

3. 返回参数

正常返回

异常返回

返回示例

4. 错误码