取消支付分订单

更新时间:2024.12.05

当支付分订单状态在已创建(state:CREATE)、用户已确认订单(collection.state: USER_CONFIRM)和待支付状态(collection.state: USER_PAYING)情况下,商户可以取消服务订单,调用接口后会同步返回取消结果,可参考支付分订单状态流转图做业务逻辑处理。

注意:

1.若因网络原因未获取到接口返回内容,商户可使用相同参数重试,该接口支持原参重入。

2.待支付状态的订单,若用户正在通过支付分订单页拉起收银台主动支付或者支付分正在进行自动扣款时,调用取消支付分订单API可能会出现"单据正在扣款中,请稍后再试"的报错,可等待3min后重试。

接口说明

支持商户:【普通商户】

请求方式:【POST】/v3/payscore/serviceorder/{out_order_no}/cancel

请求域名:【主域名】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_order_no  必填 string(32)

【商户服务订单号】商户系统内部服务订单号,商户在创建支付分接口中填入的out_order_no参数。


body 包体参数

appid  必填 string(32)

【公众账号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理。完结订单和取消订单需要和创单传入的appid保持一致。


service_id  选填 string(32)

【服务ID】商户支付分服务的唯一标识,由32位数字组成。支付分产品权限审核通过后,微信支付运营会向商户提供该ID。


reason  必填 string(50)

【撤销原因】支付分取消订单原因,长度不能超过50个字符,用户微信收到的取消订单消息通知会展示该字段。

请求示例

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

应答参数

200 OK

appid  必填 string(32)

【公众账号ID】是微信开放平台和微信公众平台为开发者的应用程序(APP、小程序、公众号)提供的一个唯一标识。 开发者需要先在微信开放平台或微信公众平台中申请ID,然后在商户平台中绑定,详见直连商户与AppID账号关联管理。完结订单和取消订单需要和创单传入的appid保持一致。


mchid  必填 string(32)

【商户号】调用支付分创单接口提交的商户号,商户号需开通支付分产品权限,且与appid有绑定关系,详见直连商户与AppID账号关联管理


out_order_no  必填 string(32)

【商户订单号】商户系统内部服务订单号,商户在创建支付分接口中填入的out_order_no参数。


service_id  必填 string(32)

【服务ID】商户支付分服务的唯一标识,由32位数字组成。支付分产品权限审核通过后,微信支付运营会向商户提供该ID。


order_id  必填 string(128)

【微信支付服务订单号】支付分订单在微信侧的唯一标识,31位数字,开头由1000000000+年月日组成。

应答示例

200 OK

1{
2  "appid" : "wxd678efh567hg6787",
3  "mchid" : "1230000109",
4  "out_order_no" : "1230000109",
5  "service_id" : "2002000000000558128851361561536",
6  "order_id" : "15646546545165651651"
7}
8

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

业务错误码

状态码

错误码

描述

解决方案

400

INVALID_ORDER_STATE

单据状态错误

确认操作是否符合流程

400

INVALID_REQUEST

请求参数符合参数格式,但不符合业务规则

请确认相同单号是否使用了不同的参数

400

ORDER_CANCELED

单据已取消

当前状态无需操作

400

ORDER_DONE

订单已完成

当前状态无需操作

403

NO_AUTH

商户信息不合法

登录商户平台核对,传入正确信息

404

ORDER_NOT_ EXIST

订单不存在

确认入参,传入正确单据

429

FREQUENCY_LIMITED

频率超限

请求量不要超过接口调用频率限制

500

SYSTEM_ERROR

系统错误

5开头的状态码都为系统问题,请使用相同参数稍后重新调用

 

 

反馈
咨询
目录
置顶