失效商品券批次
更新时间：2025.08.28品牌方可以通过该接口使已经创建的某个商品券批次失效。
注意：
调用本接口只会失效单个批次，商品券本身以及其他商品券批次不受影响。
失效商品券批次后，该批次不会有新的用户领券事件，但历史已经通过该批次发放的用户商品券仍然有效。
前置条件：商品券批次处于 SENDING 或 PAUSED 状态
频率限制：20/s
接口说明
支持商户：【品牌商户】
请求方式：【POST】/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}/deactivate
请求域名：【主域名】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
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID，接口将会校验两者的关联关系，参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥： 1、接收到接口的返回内容，需要使用微信支付公钥进行验签； 2、调用含有敏感信息参数（如姓名、身份证号码）的接口时，需要使用微信支付公钥加密敏感信息后再传输参数，加密指引请参考微信支付公钥加密敏感信息指引。
path 路径参数
product_coupon_id 必填 string
【商品券ID】 商品券的唯一标识，创建商品券时由微信支付生成
stock_id 必填 string
【批次ID】 商品券批次的唯一标识，商品券批次创建时由微信支付生成（可使用创建商品券或添加商品券批次创建），请确保该批次属于 product_coupon_id 对应的商品券
body 包体参数
out_request_no 必填 string(40)
【失效请求单号】 品牌失效批次的请求流水号，品牌侧需保持唯一性，可使用 数字、大小写字母、下划线_、短横线- 组成，长度在6-40个字符之间
deactivate_reason 必填 string(150)
【失效原因】 记录批次失效原因，长度不超过150个UTF-8字符
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/product-coupons/200000001/stocks/123456789/deactivate \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "out_request_no" : "34657_20250101_123456", 9 "deactivate_reason" : "批次信息有误，重新创建" 10 }' 11
需配合微信支付工具库 WXPayUtility 使用，请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库，参考：https://pay.weixin.qq.com/doc/brand/4015826861 4 5import com.google.gson.annotations.SerializedName; 6import com.google.gson.annotations.Expose; 7import okhttp3.MediaType; 8import okhttp3.OkHttpClient; 9import okhttp3.Request; 10import okhttp3.RequestBody; 11import okhttp3.Response; 12 13import java.io.IOException; 14import java.io.UncheckedIOException; 15import java.security.PrivateKey; 16import java.security.PublicKey; 17import java.util.ArrayList; 18import java.util.HashMap; 19import java.util.List; 20import java.util.Map; 21 22/** 23 * 失效商品券批次 24 */ 25public class DeactivateStock { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}/deactivate"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289 32 DeactivateStock client = new DeactivateStock( 33 "xxxxxxxx", // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径，本地文件路径 38 ); 39 40 DeactivateStockRequest request = new DeactivateStockRequest(); 41 request.productCouponId = "200000001"; 42 request.stockId = "123456789"; 43 request.outRequestNo = "34657_20250101_123456"; 44 request.deactivateReason = "批次信息有误，重新创建"; 45 try { 46 StockEntity response = client.run(request); 47 // TODO: 请求成功，继续业务逻辑 48 System.out.println(response); 49 } catch (WXPayBrandUtility.ApiException e) { 50 // TODO: 请求失败，根据状态码执行不同的逻辑 51 e.printStackTrace(); 52 } 53 } 54 55 public StockEntity run(DeactivateStockRequest request) { 56 String uri = PATH; 57 uri = uri.replace("{product_coupon_id}", WXPayBrandUtility.urlEncode(request.productCouponId)); 58 uri = uri.replace("{stock_id}", WXPayBrandUtility.urlEncode(request.stockId)); 59 String reqBody = WXPayBrandUtility.toJson(request); 60 61 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 62 reqBuilder.addHeader("Accept", "application/json"); 63 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 64 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 65 reqBuilder.addHeader("Content-Type", "application/json"); 66 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 67 reqBuilder.method(METHOD, requestBody); 68 Request httpRequest = reqBuilder.build(); 69 70 // 发送HTTP请求 71 OkHttpClient client = new OkHttpClient.Builder().build(); 72 try (Response httpResponse = client.newCall(httpRequest).execute()) { 73 String respBody = WXPayBrandUtility.extractBody(httpResponse); 74 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 75 // 2XX 成功，验证应答签名 76 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 77 httpResponse.headers(), respBody); 78 79 // 从HTTP应答报文构建返回数据 80 return WXPayBrandUtility.fromJson(respBody, StockEntity.class); 81 } else { 82 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 83 } 84 } catch (IOException e) { 85 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 86 } 87 } 88 89 private final String brand_id; 90 private final String certificateSerialNo; 91 private final PrivateKey privateKey; 92 private final String wechatPayPublicKeyId; 93 private final PublicKey wechatPayPublicKey; 94 95 public DeactivateStock(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 96 this.brand_id = brand_id; 97 this.certificateSerialNo = certificateSerialNo; 98 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 99 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 100 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 101 } 102 103 public static class DeactivateStockRequest { 104 @SerializedName("out_request_no") 105 public String outRequestNo; 106 107 @SerializedName("product_coupon_id") 108 @Expose(serialize = false) 109 public String productCouponId; 110 111 @SerializedName("stock_id") 112 @Expose(serialize = false) 113 public String stockId; 114 115 @SerializedName("deactivate_reason") 116 public String deactivateReason; 117 } 118 119 public static class StockEntity { 120 @SerializedName("product_coupon_id") 121 public String productCouponId; 122 123 @SerializedName("stock_id") 124 public String stockId; 125 126 @SerializedName("remark") 127 public String remark; 128 129 @SerializedName("coupon_code_mode") 130 public CouponCodeMode couponCodeMode; 131 132 @SerializedName("coupon_code_count_info") 133 public CouponCodeCountInfo couponCodeCountInfo; 134 135 @SerializedName("stock_send_rule") 136 public StockSendRule stockSendRule; 137 138 @SerializedName("single_usage_rule") 139 public SingleUsageRule singleUsageRule; 140 141 @SerializedName("sequential_usage_rule") 142 public SequentialUsageRule sequentialUsageRule; 143 144 @SerializedName("usage_rule_display_info") 145 public UsageRuleDisplayInfo usageRuleDisplayInfo; 146 147 @SerializedName("coupon_display_info") 148 public CouponDisplayInfo couponDisplayInfo; 149 150 @SerializedName("notify_config") 151 public NotifyConfig notifyConfig; 152 153 @SerializedName("store_scope") 154 public StockStoreScope storeScope; 155 156 @SerializedName("sent_count_info") 157 public StockSentCountInfo sentCountInfo; 158 159 @SerializedName("state") 160 public StockState state; 161 162 @SerializedName("deactivate_request_no") 163 public String deactivateRequestNo; 164 165 @SerializedName("deactivate_time") 166 public String deactivateTime; 167 168 @SerializedName("deactivate_reason") 169 public String deactivateReason; 170 } 171 172 public enum CouponCodeMode { 173 @SerializedName("WECHATPAY") 174 WECHATPAY, 175 @SerializedName("UPLOAD") 176 UPLOAD, 177 @SerializedName("API_ASSIGN") 178 API_ASSIGN 179 } 180 181 public static class CouponCodeCountInfo { 182 @SerializedName("total_count") 183 public Long totalCount; 184 185 @SerializedName("available_count") 186 public Long availableCount; 187 } 188 189 public static class StockSendRule { 190 @SerializedName("max_count") 191 public Long maxCount; 192 193 @SerializedName("max_count_per_day") 194 public Long maxCountPerDay; 195 196 @SerializedName("max_count_per_user") 197 public Long maxCountPerUser; 198 } 199 200 public static class SingleUsageRule { 201 @SerializedName("coupon_available_period") 202 public SingleCouponAvailablePeriod couponAvailablePeriod; 203 204 @SerializedName("normal_coupon") 205 public NormalCouponUsageRule normalCoupon; 206 207 @SerializedName("discount_coupon") 208 public DiscountCouponUsageRule discountCoupon; 209 210 @SerializedName("exchange_coupon") 211 public ExchangeCouponUsageRule exchangeCoupon; 212 } 213 214 public static class SequentialUsageRule { 215 @SerializedName("coupon_available_period") 216 public SequentialCouponAvailablePeriod couponAvailablePeriod; 217 218 @SerializedName("normal_coupon_list") 219 public List<NormalCouponUsageRule> normalCouponList; 220 221 @SerializedName("discount_coupon_list") 222 public List<DiscountCouponUsageRule> discountCouponList; 223 224 @SerializedName("exchange_coupon_list") 225 public List<ExchangeCouponUsageRule> exchangeCouponList; 226 227 @SerializedName("special_first") 228 public Boolean specialFirst; 229 } 230 231 public static class UsageRuleDisplayInfo { 232 @SerializedName("coupon_usage_method_list") 233 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 234 235 @SerializedName("mini_program_appid") 236 public String miniProgramAppid; 237 238 @SerializedName("mini_program_path") 239 public String miniProgramPath; 240 241 @SerializedName("app_path") 242 public String appPath; 243 244 @SerializedName("usage_description") 245 public String usageDescription; 246 247 @SerializedName("coupon_available_store_info") 248 public CouponAvailableStoreInfo couponAvailableStoreInfo; 249 } 250 251 public static class CouponDisplayInfo { 252 @SerializedName("code_display_mode") 253 public CouponCodeDisplayMode codeDisplayMode; 254 255 @SerializedName("background_color") 256 public String backgroundColor; 257 258 @SerializedName("entrance_mini_program") 259 public EntranceMiniProgram entranceMiniProgram; 260 261 @SerializedName("entrance_official_account") 262 public EntranceOfficialAccount entranceOfficialAccount; 263 264 @SerializedName("entrance_finder") 265 public EntranceFinder entranceFinder; 266 } 267 268 public static class NotifyConfig { 269 @SerializedName("notify_appid") 270 public String notifyAppid; 271 } 272 273 public enum StockStoreScope { 274 @SerializedName("NONE") 275 NONE, 276 @SerializedName("ALL") 277 ALL, 278 @SerializedName("SPECIFIC") 279 SPECIFIC 280 } 281 282 public static class StockSentCountInfo { 283 @SerializedName("total_count") 284 public Long totalCount; 285 286 @SerializedName("today_count") 287 public Long todayCount; 288 } 289 290 public enum StockState { 291 @SerializedName("AUDITING") 292 AUDITING, 293 @SerializedName("SENDING") 294 SENDING, 295 @SerializedName("PAUSED") 296 PAUSED, 297 @SerializedName("STOPPED") 298 STOPPED, 299 @SerializedName("DEACTIVATED") 300 DEACTIVATED 301 } 302 303 public static class SingleCouponAvailablePeriod { 304 @SerializedName("available_begin_time") 305 public String availableBeginTime; 306 307 @SerializedName("available_end_time") 308 public String availableEndTime; 309 310 @SerializedName("available_days") 311 public Long availableDays; 312 313 @SerializedName("wait_days_after_receive") 314 public Long waitDaysAfterReceive; 315 316 @SerializedName("weekly_available_period") 317 public FixedWeekPeriod weeklyAvailablePeriod; 318 319 @SerializedName("irregular_available_period_list") 320 public List<TimePeriod> irregularAvailablePeriodList; 321 } 322 323 public static class NormalCouponUsageRule { 324 @SerializedName("threshold") 325 public Long threshold; 326 327 @SerializedName("discount_amount") 328 public Long discountAmount; 329 } 330 331 public static class DiscountCouponUsageRule { 332 @SerializedName("threshold") 333 public Long threshold; 334 335 @SerializedName("percent_off") 336 public Long percentOff; 337 } 338 339 public static class ExchangeCouponUsageRule { 340 @SerializedName("threshold") 341 public Long threshold; 342 343 @SerializedName("exchange_price") 344 public Long exchangePrice; 345 } 346 347 public static class SequentialCouponAvailablePeriod { 348 @SerializedName("available_begin_time") 349 public String availableBeginTime; 350 351 @SerializedName("available_end_time") 352 public String availableEndTime; 353 354 @SerializedName("wait_days_after_receive") 355 public Long waitDaysAfterReceive; 356 357 @SerializedName("weekly_available_period") 358 public FixedWeekPeriod weeklyAvailablePeriod; 359 360 @SerializedName("irregular_available_period_list") 361 public List<TimePeriod> irregularAvailablePeriodList; 362 } 363 364 public enum CouponUsageMethod { 365 @SerializedName("OFFLINE") 366 OFFLINE, 367 @SerializedName("MINI_PROGRAM") 368 MINI_PROGRAM, 369 @SerializedName("APP") 370 APP, 371 @SerializedName("PAYMENT_CODE") 372 PAYMENT_CODE 373 } 374 375 public static class CouponAvailableStoreInfo { 376 @SerializedName("description") 377 public String description; 378 379 @SerializedName("mini_program_appid") 380 public String miniProgramAppid; 381 382 @SerializedName("mini_program_path") 383 public String miniProgramPath; 384 } 385 386 public enum CouponCodeDisplayMode { 387 @SerializedName("INVISIBLE") 388 INVISIBLE, 389 @SerializedName("BARCODE") 390 BARCODE, 391 @SerializedName("QRCODE") 392 QRCODE 393 } 394 395 public static class EntranceMiniProgram { 396 @SerializedName("appid") 397 public String appid; 398 399 @SerializedName("path") 400 public String path; 401 402 @SerializedName("entrance_wording") 403 public String entranceWording; 404 405 @SerializedName("guidance_wording") 406 public String guidanceWording; 407 } 408 409 public static class EntranceOfficialAccount { 410 @SerializedName("appid") 411 public String appid; 412 } 413 414 public static class EntranceFinder { 415 @SerializedName("finder_id") 416 public String finderId; 417 418 @SerializedName("finder_video_id") 419 public String finderVideoId; 420 421 @SerializedName("finder_video_cover_image_url") 422 public String finderVideoCoverImageUrl; 423 } 424 425 public static class FixedWeekPeriod { 426 @SerializedName("day_list") 427 public List<WeekEnum> dayList; 428 429 @SerializedName("day_period_list") 430 public List<PeriodOfTheDay> dayPeriodList; 431 } 432 433 public static class TimePeriod { 434 @SerializedName("begin_time") 435 public String beginTime; 436 437 @SerializedName("end_time") 438 public String endTime; 439 } 440 441 public enum WeekEnum { 442 @SerializedName("MONDAY") 443 MONDAY, 444 @SerializedName("TUESDAY") 445 TUESDAY, 446 @SerializedName("WEDNESDAY") 447 WEDNESDAY, 448 @SerializedName("THURSDAY") 449 THURSDAY, 450 @SerializedName("FRIDAY") 451 FRIDAY, 452 @SerializedName("SATURDAY") 453 SATURDAY, 454 @SerializedName("SUNDAY") 455 SUNDAY 456 } 457 458 public static class PeriodOfTheDay { 459 @SerializedName("begin_time") 460 public Long beginTime; 461 462 @SerializedName("end_time") 463 public Long endTime; 464 } 465 466} 467
需配合微信支付工具库 wxpay_utility 使用，请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_brand_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/brand/4015826866 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10 "strings" 11 "time" 12) 13 14func main() { 15 // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289 16 config, err := wxpay_brand_utility.CreateBrandConfig( 17 "xxxxxxxx", // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 18 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 19 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径 20 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 21 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径，本地文件路径 22 ) 23 if err != nil { 24 fmt.Println(err) 25 return 26 } 27 28 request := &DeactivateStockRequest{ 29 ProductCouponId: wxpay_brand_utility.String("200000001"), 30 StockId: wxpay_brand_utility.String("123456789"), 31 OutRequestNo: wxpay_brand_utility.String("34657_20250101_123456"), 32 DeactivateReason: wxpay_brand_utility.String("批次信息有误，重新创建"), 33 } 34 35 response, err := DeactivateStock(config, request) 36 if err != nil { 37 fmt.Printf("请求失败: %+v\n", err) 38 // TODO: 请求失败，根据状态码执行不同的处理 39 return 40 } 41 42 // TODO: 请求成功，继续业务逻辑 43 fmt.Printf("请求成功: %+v\n", response) 44} 45 46func DeactivateStock(config *wxpay_brand_utility.BrandConfig, request *DeactivateStockRequest) (response *StockEntity, err error) { 47 const ( 48 host = "https://api.mch.weixin.qq.com" 49 method = "POST" 50 path = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}/stocks/{stock_id}/deactivate" 51 ) 52 53 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 54 if err != nil { 55 return nil, err 56 } 57 reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1) 58 reqUrl.Path = strings.Replace(reqUrl.Path, "{stock_id}", url.PathEscape(*request.StockId), -1) 59 reqBody, err := json.Marshal(request) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 httpRequest.Header.Set("Content-Type", "application/json") 70 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 71 if err != nil { 72 return nil, err 73 } 74 httpRequest.Header.Set("Authorization", authorization) 75 76 client := &http.Client{} 77 httpResponse, err := client.Do(httpRequest) 78 if err != nil { 79 return nil, err 80 } 81 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 82 if err != nil { 83 return nil, err 84 } 85 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 86 // 2XX 成功，验证应答签名 87 err = wxpay_brand_utility.ValidateResponse( 88 config.WechatPayPublicKeyId(), 89 config.WechatPayPublicKey(), 90 &httpResponse.Header, 91 respBody, 92 ) 93 if err != nil { 94 return nil, err 95 } 96 response := &StockEntity{} 97 if err := json.Unmarshal(respBody, response); err != nil { 98 return nil, err 99 } 100 101 return response, nil 102 } else { 103 return nil, wxpay_brand_utility.NewApiException( 104 httpResponse.StatusCode, 105 httpResponse.Header, 106 respBody, 107 ) 108 } 109} 110 111type DeactivateStockRequest struct { 112 OutRequestNo *string `json:"out_request_no,omitempty"` 113 ProductCouponId *string `json:"product_coupon_id,omitempty"` 114 StockId *string `json:"stock_id,omitempty"` 115 DeactivateReason *string `json:"deactivate_reason,omitempty"` 116} 117 118func (o *DeactivateStockRequest) MarshalJSON() ([]byte, error) { 119 type Alias DeactivateStockRequest 120 a := &struct { 121 ProductCouponId *string `json:"product_coupon_id,omitempty"` 122 StockId *string `json:"stock_id,omitempty"` 123 *Alias 124 }{ 125 // 序列化时移除非 Body 字段 126 ProductCouponId: nil, 127 StockId: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type StockEntity struct { 134 ProductCouponId *string `json:"product_coupon_id,omitempty"` 135 StockId *string `json:"stock_id,omitempty"` 136 Remark *string `json:"remark,omitempty"` 137 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 138 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 139 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 140 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 141 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 142 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 143 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 144 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 145 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 146 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 147 State *StockState `json:"state,omitempty"` 148 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 149 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 150 DeactivateReason *string `json:"deactivate_reason,omitempty"` 151} 152 153type CouponCodeMode string 154 155func (e CouponCodeMode) Ptr() *CouponCodeMode { 156 return &e 157} 158 159const ( 160 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 161 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 162 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 163) 164 165type CouponCodeCountInfo struct { 166 TotalCount *int64 `json:"total_count,omitempty"` 167 AvailableCount *int64 `json:"available_count,omitempty"` 168} 169 170type StockSendRule struct { 171 MaxCount *int64 `json:"max_count,omitempty"` 172 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 173 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 174} 175 176type SingleUsageRule struct { 177 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 178 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 179 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 180 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 181} 182 183type SequentialUsageRule struct { 184 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 185 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 186 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 187 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 188 SpecialFirst *bool `json:"special_first,omitempty"` 189} 190 191type UsageRuleDisplayInfo struct { 192 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 193 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 194 MiniProgramPath *string `json:"mini_program_path,omitempty"` 195 AppPath *string `json:"app_path,omitempty"` 196 UsageDescription *string `json:"usage_description,omitempty"` 197 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 198} 199 200type CouponDisplayInfo struct { 201 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 202 BackgroundColor *string `json:"background_color,omitempty"` 203 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 204 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 205 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 206} 207 208type NotifyConfig struct { 209 NotifyAppid *string `json:"notify_appid,omitempty"` 210} 211 212type StockStoreScope string 213 214func (e StockStoreScope) Ptr() *StockStoreScope { 215 return &e 216} 217 218const ( 219 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 220 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 221 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 222) 223 224type StockSentCountInfo struct { 225 TotalCount *int64 `json:"total_count,omitempty"` 226 TodayCount *int64 `json:"today_count,omitempty"` 227} 228 229type StockState string 230 231func (e StockState) Ptr() *StockState { 232 return &e 233} 234 235const ( 236 STOCKSTATE_AUDITING StockState = "AUDITING" 237 STOCKSTATE_SENDING StockState = "SENDING" 238 STOCKSTATE_PAUSED StockState = "PAUSED" 239 STOCKSTATE_STOPPED StockState = "STOPPED" 240 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 241) 242 243type SingleCouponAvailablePeriod struct { 244 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 245 AvailableEndTime *string `json:"available_end_time,omitempty"` 246 AvailableDays *int64 `json:"available_days,omitempty"` 247 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 248 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 249 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 250} 251 252type NormalCouponUsageRule struct { 253 Threshold *int64 `json:"threshold,omitempty"` 254 DiscountAmount *int64 `json:"discount_amount,omitempty"` 255} 256 257type DiscountCouponUsageRule struct { 258 Threshold *int64 `json:"threshold,omitempty"` 259 PercentOff *int64 `json:"percent_off,omitempty"` 260} 261 262type ExchangeCouponUsageRule struct { 263 Threshold *int64 `json:"threshold,omitempty"` 264 ExchangePrice *int64 `json:"exchange_price,omitempty"` 265} 266 267type SequentialCouponAvailablePeriod struct { 268 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 269 AvailableEndTime *string `json:"available_end_time,omitempty"` 270 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 271 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 272 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 273} 274 275type CouponUsageMethod string 276 277func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 278 return &e 279} 280 281const ( 282 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 283 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 284 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 285 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 286) 287 288type CouponAvailableStoreInfo struct { 289 Description *string `json:"description,omitempty"` 290 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 291 MiniProgramPath *string `json:"mini_program_path,omitempty"` 292} 293 294type CouponCodeDisplayMode string 295 296func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 297 return &e 298} 299 300const ( 301 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 302 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 303 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 304) 305 306type EntranceMiniProgram struct { 307 Appid *string `json:"appid,omitempty"` 308 Path *string `json:"path,omitempty"` 309 EntranceWording *string `json:"entrance_wording,omitempty"` 310 GuidanceWording *string `json:"guidance_wording,omitempty"` 311} 312 313type EntranceOfficialAccount struct { 314 Appid *string `json:"appid,omitempty"` 315} 316 317type EntranceFinder struct { 318 FinderId *string `json:"finder_id,omitempty"` 319 FinderVideoId *string `json:"finder_video_id,omitempty"` 320 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 321} 322 323type FixedWeekPeriod struct { 324 DayList []WeekEnum `json:"day_list,omitempty"` 325 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 326} 327 328type TimePeriod struct { 329 BeginTime *string `json:"begin_time,omitempty"` 330 EndTime *string `json:"end_time,omitempty"` 331} 332 333type WeekEnum string 334 335func (e WeekEnum) Ptr() *WeekEnum { 336 return &e 337} 338 339const ( 340 WEEKENUM_MONDAY WeekEnum = "MONDAY" 341 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 342 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 343 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 344 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 345 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 346 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 347) 348 349type PeriodOfTheDay struct { 350 BeginTime *int64 `json:"begin_time,omitempty"` 351 EndTime *int64 `json:"end_time,omitempty"` 352} 353
应答参数
200 OK
product_coupon_id 必填 string(40)
【商品券ID】 商品券的唯一标识，由微信支付生成
stock_id 必填 string(40)
【批次ID】 商品券批次的唯一标识，由微信支付生成
remark 选填 string(20)
【备注】 仅配置品牌可见，用于自定义信息
coupon_code_mode 必填 string
【券Code分配模式】 决定发券时用户商品券Code如何产生
可选取值
WECHATPAY: 微信支付随机生成，发券时由微信支付系统自动随机生成券码，品牌方无需干预，微信支付随机生成的券Code长度限制为40个字符以内UPLOAD: 品牌方预上传Code，品牌方需先使用预上传券Code API上传自定义Code，微信支付系统发券时从中随机选取，当预存Code不足时可能影响发券，品牌应及时补充API_ASSIGN: 品牌方自行指定，品牌方通过发券API自行发券时指定，微信支付系统不再进行自动分配。特别注意：这种模式的商品批次只可由品牌方自行发券，无法在摇一摇有优惠等微信支付渠道投放
coupon_code_count_info 选填 object
【品牌方预上传的券Code数量信息】 当且仅当 coupon_code_mode 为 UPLOAD 时存在此字段
 | 属性 |
total_count 必填 integer 【已上传的Code总数】 品牌方为此批次已经上传过的券Code总数量 available_count 必填 integer 【当前可用的Code数】 品牌方为此批次已经上传过的券Code中，当前剩余可用的券Code数量 |
stock_send_rule 必填 object
【发放规则】 发放规则
| 属性 |
max_count 必填 integer 【发放次数总上限】 批次在生命周期内总发放次数，最多 100,000,000 次 max_count_per_day 选填 integer 【每日发放次数上限】 批次在每天内发放次数上限，每日刷新，最多 100,000,000 次。默认不限制每日发放上限 max_count_per_user 必填 integer 【每个用户领取次数上限】 每个用户最多可领取本批次的次数，最多 100 次。 |
single_usage_rule 选填 object
【单券使用规则】 当且仅当 usage_mode 为 SINGLE 时提供，其他场景不提供
| 属性 | ||||||||||||||||||||||||||||
coupon_available_period 必填 object 【券可核销时间】 确定用户领券后在什么时间段内可以核销
normal_coupon 选填 object 【满减券使用规则】 当且仅当
discount_coupon 选填 object 【折扣券使用规则】 当且仅当
exchange_coupon 选填 object 【兑换券使用规则】 当且仅当
|
sequential_usage_rule 选填 object
【多次优惠使用规则】 当且仅当 usage_mode 为 SEQUENTIAL 时提供，其他场景不提供
| 属性 | ||||||||||||||||||||||||||||
coupon_available_period 必填 object 【多次优惠可核销时间】 确定用户领取多次优惠后在什么时间段内可以核销，多次优惠可核销时间不会超过多次优惠有效天数（多次优惠商品券中配置的
normal_coupon_list 选填 array[object] 【满减券使用规则】 当且仅当
discount_coupon_list 选填 array[object] 【折扣券使用规则】 当且仅当
exchange_coupon_list 选填 array[object] 【兑换券使用规则】 当且仅当
special_first 选填 boolean 【多次优惠是否提供首笔特惠】 默认情况下为 当此字段设置为 |
usage_rule_display_info 必填 object
【券使用规则展示信息】 券使用规则展示信息
| 属性 | ||||
coupon_usage_method_list 必填 array[string] 【券使用方式列表】 可以配置多种使用方式 可选取值
mini_program_appid 选填 string 【小程序AppID】 品牌方小程序AppID，可在微信公众平台查看，该小程序与品牌存在绑定关系。 在 mini_program_path 选填 string 【小程序跳转路径】 品牌方小程序内部跳转路径。 在 app_path 选填 string 【APP跳转路径】 品牌方APP跳转路径，在 usage_description 必填 string(1000) 【券使用说明】 用于说明详细的券规则，长度不超过1000个UTF-8字符 coupon_available_store_info 选填 object 【券可用门店信息】 用于描述全部可用门店信息，可配置小程序跳转地址进行展示
|
coupon_display_info 必填 object
【用户商品券展示信息】 用户商品券在卡包中的展示详情，包括引导用户的自定义入口
| 属性 | ||||||||||||
code_display_mode 必填 string 【用户商品券Code展示模式】 决定用户商品券Code在卡包中的展示形态 可选取值
background_color 选填 string 【背景颜色】 券的背景颜色，可设置10种颜色，色值请参考下方说明。颜色取值为颜色图中的颜色名称，不填默认为
entrance_mini_program 选填 object 【小程序入口】 展示跳转小程序的入口
entrance_official_account 选填 object 【公众号入口】 展示跳转公众号的入口
entrance_finder 选填 object 【视频号入口】 展示跳转视频号的入口
|
notify_config 必填 object
【事件通知配置】 发生券相关事件时，微信支付会向品牌方发送通知，需要提供通知相关配置
| 属性 |
notify_appid 必填 string 【事件通知AppID】 品牌方小程序或公众号AppID，可在微信公众平台查看，用于券事件通知时计算用户的OpenID，需要与品牌存在绑定关系 |
store_scope 必填 string
【可用门店范围】 控制该批次可以在品牌下哪些门店使用
可选取值
NONE: 无关联门店，该批次对外不展示可用门店信息ALL: 所有门店可用，该批次在品牌下的所有门店可用，品牌无需为该批次关联门店列表SPECIFIC: 特定门店可用，品牌需调用关联门店接口关联门店，关联后该批次在关联的门店可用
sent_count_info 必填 object
【已发放次数】 本批次已发放次数
| 属性 |
total_count 必填 integer 【已发放总次数】 批次在生命周期内已发放次数 today_count 必填 integer 【当天已发放次数】 批次在当天已发放次数 |
state 必填 string
【批次状态】 商品券批次状态
可选取值
AUDITING: 审批中SENDING: 发放中PAUSED: 已暂停STOPPED: 已停止，当前已到达结束时间DEACTIVATED: 已失效，品牌方主动调用失效接口使批次失效
deactivate_request_no 选填 string
【失效请求单号】 当且仅当 state 为 DEACTIVATED 时提供，返回品牌方调用失效接口时传入的请求流水号
deactivate_time 选填 string
【失效时间】 当且仅当 state 为 DEACTIVATED 时提供，遵循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秒。
deactivate_reason 选填 string
【失效原因】 当且仅当 state 为 DEACTIVATED 时提供，返回品牌方调用失效商品券批次接口时传入的失效原因
应答示例
200 OK
1{ 2 "product_coupon_id" : "200000001", 3 "stock_id" : "123456789", 4 "remark" : "满减券", 5 "coupon_code_mode" : "UPLOAD", 6 "coupon_code_count_info" : { 7 "total_count" : 10000, 8 "available_count" : 999 9 }, 10 "stock_send_rule" : { 11 "max_count" : 10000000, 12 "max_count_per_day" : 10000, 13 "max_count_per_user" : 1 14 }, 15 "single_usage_rule" : { 16 "coupon_available_period" : { 17 "available_begin_time" : "2025-01-01T00:00:00+08:00", 18 "available_end_time" : "2025-10-01T00:00:00+08:00", 19 "available_days" : 10, 20 "wait_days_after_receive" : 1, 21 "weekly_available_period" : { 22 "day_list" : [ 23 "MONDAY" 24 ], 25 "day_period_list" : [ 26 { 27 "begin_time" : 60, 28 "end_time" : 86399 29 } 30 ] 31 }, 32 "irregular_available_period_list" : [ 33 { 34 "begin_time" : "2025-01-01T00:00:00+08:00", 35 "end_time" : "2025-10-01T00:00:00+08:00" 36 } 37 ] 38 }, 39 "normal_coupon" : { 40 "threshold" : 10000, 41 "discount_amount" : 100 42 }, 43 "discount_coupon" : { 44 "threshold" : 10000, 45 "percent_off" : 30 46 }, 47 "exchange_coupon" : { 48 "threshold" : 10000, 49 "exchange_price" : 100 50 } 51 }, 52 "sequential_usage_rule" : { 53 "coupon_available_period" : { 54 "available_begin_time" : "2025-01-01T00:00:00+08:00", 55 "available_end_time" : "2025-10-01T00:00:00+08:00", 56 "wait_days_after_receive" : 1, 57 "weekly_available_period" : { 58 "day_list" : [ 59 "MONDAY" 60 ], 61 "day_period_list" : [ 62 { 63 "begin_time" : 60, 64 "end_time" : 86399 65 } 66 ] 67 }, 68 "irregular_available_period_list" : [ 69 { 70 "begin_time" : "2025-01-01T00:00:00+08:00", 71 "end_time" : "2025-10-01T00:00:00+08:00" 72 } 73 ] 74 }, 75 "normal_coupon_list" : [ 76 { 77 "threshold" : 10000, 78 "discount_amount" : 100 79 } 80 ], 81 "discount_coupon_list" : [ 82 { 83 "threshold" : 10000, 84 "percent_off" : 30 85 } 86 ], 87 "exchange_coupon_list" : [ 88 { 89 "threshold" : 10000, 90 "exchange_price" : 100 91 } 92 ], 93 "special_first" : false 94 }, 95 "usage_rule_display_info" : { 96 "coupon_usage_method_list" : [ 97 "MINI_PROGRAM" 98 ], 99 "mini_program_appid" : "wx1234567890", 100 "mini_program_path" : "/pages/index/product", 101 "app_path" : "https://www.example.com/jump-to-app", 102 "usage_description" : "全场可用", 103 "coupon_available_store_info" : { 104 "description" : "可在上海市区的所有门店使用，详细列表参考小程序内信息为准", 105 "mini_program_appid" : "wx1234567890", 106 "mini_program_path" : "/pages/index/store-list" 107 } 108 }, 109 "coupon_display_info" : { 110 "code_display_mode" : "QRCODE", 111 "background_color" : "Color010", 112 "entrance_mini_program" : { 113 "appid" : "wx1234567890", 114 "path" : "/pages/index/product", 115 "entrance_wording" : "欢迎选购", 116 "guidance_wording" : "获取更多优惠" 117 }, 118 "entrance_official_account" : { 119 "appid" : "wx1234567890" 120 }, 121 "entrance_finder" : { 122 "finder_id" : "gh_12345678", 123 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 124 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 125 } 126 }, 127 "notify_config" : { 128 "notify_appid" : "wx4fd12345678" 129 }, 130 "store_scope" : "SPECIFIC", 131 "sent_count_info" : { 132 "total_count" : 100, 133 "today_count" : 10 134 }, 135 "state" : "SENDING", 136 "deactivate_request_no" : "1002600620019090123143254436", 137 "deactivate_time" : "2025-01-01T00:00+08:00", 138 "deactivate_reason" : "批次信息有误，重新创建" 139} 140
错误码
以下是本接口返回的错误码列表。详细错误码规则，请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常，请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 单券使用模式的商品券批次，应该在「单券使用规则」中包含对应类型的优惠规则。对于文档中标记不应填写的优惠规则应删除。 | 请在「单券使用规则」中包含对应类型的优惠规则，并删除文档中标记不应填写的优惠规则。 |
400 | INVALID_REQUEST | 多次优惠使用模式的商品券批次，应该在「多次优惠使用规则」中包含对应类型的优惠规则，且数量与多次优惠的优惠次数相等 | 在「多次优惠使用规则」中包含对应类型的优惠规则，且数量与多次优惠的优惠次数相等 |
400 | INVALID_REQUEST | 单品满减券或单品折扣券不应在商品券中设置「满减券使用规则」或「折扣券使用规则」，而是应该在商品券批次中设置 | 请删除商品券中的「满减券使用规则」或「折扣券使用规则」，并在商品券批次中设置对应的优惠规则 |
403 | NO_AUTH | 品牌没有此接口权限 | 品牌没有此接口权限 |
400 | INVALID_REQUEST | 商品券支持APP核销时，必须提供「APP跳转路径」 | 请提供「APP跳转路径」参数 |
400 | PARAM_ERROR | 分页大小超出限制，请根据接口文档调整到允许的范围 | 请调整分页大小到规定范围 |
400 | INVALID_REQUEST | 商品券支持小程序核销时，必须提供「小程序AppID」 | 请提供「小程序AppID」 |
400 | INVALID_REQUEST | 单品券必须提供商品原价，请补充 | 请补充商品原价 |
400 | INVALID_REQUEST | 商品券支持小程序核销时，必须提供「小程序跳转路径」 | 请提供提供「小程序跳转路径」 |
400 | INVALID_REQUEST | 单品券必须提供商品券套餐组合信息，请补充 | 请提供商品券套餐组合信息 |
400 | PARAM_ERROR | 时间字符串格式错误，请使用 RFC3339 标准格式 | 请使用 RFC3339 标准格式 |
400 | INVALID_REQUEST | 单券模式下，全场折扣券应在商品券中提供折扣券使用规则信息 | 请在商品券中提供「折扣券使用规则信息」 |
400 | INVALID_REQUEST | 单券模式下，全场满减券应在商品券中提供满减券使用规则信息 | 请在商品券中提供「满减券使用规则信息」 |
400 | INVALID_REQUEST | 每周固定可用时间(weekly_available_period)中提供当天可用时间段时(day_period_list)，每周可用星期数(day_list)必填 | 请补充 每周可用星期数(day_list) |
400 | INVALID_REQUEST | 单券模式下，全场券需要提供「单券模式信息(single_usage_info)」 | 请提供单券模式信息(single_usage_info) |
400 | INVALID_REQUEST | 多次优惠模式下必须提供「多次优惠模式信息(sequential_usage_info)」 | 请填写 多次优惠模式信息(sequential_usage_info) |
400 | INVALID_REQUEST | 传入的OpenID不合法 | 请使用参数 AppID 对应的的OpenID |
