使券失效API

最新更新时间:2020.11.04 版本说明


商户可以通过该接口将可用券进行失效处理,券被失效后无法再被核销

接口说明

适用对象:直连商户 服务商 渠道商

请求URL:https://api.mch.weixin.qq.com/v3/marketing/busifavor/coupons/deactivate

请求方式:POST

前置条件:券的状态为SENDED

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


path 指该参数为路径参数

query 指该参数为URL参数

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


请求参数

参数名 变量 类型[长度限制] 必填 描述
券code coupon_code string[1,32] body券的唯一标识
示例值:sxxe34343434
批次号 stock_id string[1,20] body券的所属批次号
示例值:1234567891
失效请求单据号 deactivate_request_no string[1, 128] body每次失效请求的唯一标识,商户需保证唯一
示例值:1002600620019090123143254436
失效原因 deactivate_reason string[1, 64] body商户失效券的原因
示例值:此券使用时间设置错误

请求示例


{
  "coupon_code": "sxxe34343434",
  "stock_id": "1234567891",
  "deactivate_request_no": "1002600620019090123143254436",
  "deactivate_reason": "此券使用时间设置错误"
}

{
JAVA示例代码
}

返回参数

参数名 变量 类型[长度限制] 必填 描述
券成功失效的时间 wechatpay_deactivate_time string[1,32] 系统券成功失效的时间,遵循rfc3339标准格式,格式为YYYY-MM-DDTHH:mm:ss+TIMEZONE,YYYY-MM-DD表示年月日,T出现在字符串中,表示time元素的开头,HH:mm:ss表示时分秒,TIMEZONE表示时区(+08:00表示东八区时间,领先UTC 8小时,即北京时间)。例如:2015-05-20T13:29:35+08:00表示,北京时间2015年5月20日 13点29分35秒。

示例值:2020-05-20T13:29:35.08:00

返回示例


{
  "wechatpay_deactivate_time": "2020-05-20T13:29:35.120+08:00"
}
                    

http://2323weixin.qq.com
                    

错误码公共错误码

状态码 错误码 描述 解决方案
404 RESOURCE_NOT_EXISTS 批次不存在 请检查批次id
404 RESOURCE_NOT_EXISTS 券不存在 请检查券code
403 RULELIMIT 券不属于指定的批次 券不属于指定的批次
403 RULELIMIT 仅批次创建方有权限使券失效 仅批次创建方有权限使券失效
403 RULELIMIT 券已被核销 只能失效状态为SENDED的券
404 RESOURCE_NOT_EXISTS 券已被删除 只能失效状态为SENDED的券
403 RULELIMIT 券已过期,不能再进行其他操作 只能失效状态为SENDED的券


版本说明

关闭
V1.0
2020年11月04
使券失效接口上线

技术咨询

反馈有奖