取消支付分订单API

取消支付分订单API

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

订单为以下状态时可以取消订单:CREATED(已创单)、DOING(进行中)(包括商户完结支付分订单后,且支付分订单收款状态为待支付USER_PAYING)

注意:

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

接口说明

请求URL:https://api.mch.weixin.payyj.cn/v3/payscore/serviceorder/{out_order_no}/cancel

请求方式:POST

接口规则:https://wechatpay-api.gitbook.io/wechatpay-api-v3

前置条件:服务订单状态为已创单或进行中


path 指该参数为路径参数

query 指该参数需在请求URL传参

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


请求参数

参数名变量类型[长度限制]必填描述
商户服务订单号out_order_nostring[1,32]path商户系统内部服务订单号(不是交易单号),与创建订单时一致。
示例值:2304203423948239423
公众账号IDappidstring[1,32]body 微信公众平台分配的与传入的商户号建立了支付绑定关系的appid,可在公众平台查看绑定关系。
此参数需在本系统先进行配置,并与创建订单时的appid保持一致。
示例值:wxd678efh567hg6787
服务IDservice_idstring[1,32]body 该服务ID有本接口对应产品的权限 ,使用默认值0000 。
示例值:500001
取消原因reasonstring[1,50]body 按照字符计算,超过长度报错处理。
示例值:用户投诉

请求示例


{
  "appid": "wxd678efh567hg6787",
  "service_id": "500001",
  "reason": "用户投诉"
}

返回参数


处理成功,应答无内容

返回示例


204
处理成功,应答无内容
                    

错误码公共错误码

状态码错误码描述解决方案
500SYSTEM_ERROR系统错误5开头的状态码都为系统问题,请使用相同参数稍后重新调用
400PARAM_ERROR参数错误根据错误提示,传入正确参数
403NO_AUTH商户信息不合法登录商户平台核对,传入正确信息
429FREQUENCY_LIMITED频率超限请求量不要超过接口调用频率限制
400INVALID_REQUEST请求参数符合参数格式,但不符合业务规则请确认相同单号是否使用了不同的参数
404ORDER_NOT_ EXIST订单不存在确认入参,传入正确单据
400INVALID_ORDER_STATE单据状态错误确认操作是否符合流程
400ORDER_CANCELED单据已取消当前状态无需操作
400ORDER_DONE订单已完成当前状态无需操作