取消支付分订单

更新时间：2025.04.01

微信支付分订单创建之后，由于某些原因导致订单不能正常支付时，可使用此接口取消订单。

注意：

DOING状态包含了订单用户确认、已完结-待支付（USER_PAYING）的状态，因此这种状态下订单也是可以被取消的，请确认当前操作是否正确，防止误操作将完结后需要支付分收款的单据取消。

订单为以下状态时可以取消订单：CREATED（已创单）、DOING（进行中）（包括商户完结支付分订单后，且支付分订单收款状态为待支付USER_PAYING）。

特别注意：待支付（USER_PAYING）状态下，当用户正在尝试通过收银台主动支付订单金额时，取消支付分订单API无法调用成功，可等待3min后重试

1. 接口说明

适用对象：机构模式

请求URL：https://apihk.mch.weixin.qq.com/v3/payscore/oversea/partner/serviceorder/{out_order_no}/cancel

请求方式：POST

Path 指该参数为路径参数

Query 指该参数为URL参数

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

2. 请求参数

参数名	变量	类型[长度限制]	必填	描述
商户订单号	out_order_no	string[1,32]	是	Path 商户系统内部服务订单号（不是交易单号），要求32个字符内，只能是数字、大小写字母_-\|* 且在同一个商户号下唯一。示例值：out_order_no_666
服务ID	service_id	string[1,32]	否	Body 该服务ID需有本接口对应产品的权限示例值：2002000000000558128851361561536
子商户号	sub_mchid	string[1,32]	是	Body 子商户商户号，由微信支付生成并下发示例值：1900000109
撤销原因	reason	string[1,50]	是	Path 支持50个字符，按照字符计算，超过长度报错处理示例值：用户投诉

3. 请求示例

1curl -X POST \
2https://api.mch.weixin.qq.com/v3/payscore/oversea/partner/serviceorder/1234323JKHDFE1243252/cancel \
3-H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4-H "Accept: application/json" \
5-H "Content-Type: application/json" \
6-d '{
7  "service_id" : "2002000000000558128851361561536",
8  "sub_mchid" : "1900000109",
9  "reason" : "用户投诉"
10}'

4. 返回参数

无返回数据(HTTP状态码为204)

5. 返回示例

1204 No Content
2
3无返回数据

6. 错误码

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