创建商品券
更新时间:2025.08.05品牌方可以通过该接口创建商品券和批次。微信支付创建成功后,会返回此次创建的商品券以及批次。品牌方可在【经营平台】上配置【活动】对商品券进行投放。
频率限制:20/s
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/product-coupon/product-coupons
请求域名:【主域名】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、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
body 包体参数
out_request_no 必填 string(40)
【创建请求单号】 品牌创建商品券的请求流水号,品牌侧需保持唯一性,可使用 数字、大小写字母、下划线_、短横线- 组成,长度在6-40个字符之间
scope 必填 string
【优惠范围】 商品券的优惠范围
可选取值
ALL: 全场券,此时券类型type仅可配置为NORMAL或DISCOUNTSINGLE: 单品券,此时券类型type配置不受限制,即可配置为NORMAL、DISCOUNT或EXCHANGE
type 必填 string
【商品券类型】 商品券的优惠类型
可选取值
NORMAL: 满减券DISCOUNT: 折扣券EXCHANGE: 兑换券,仅在scope为SINGLE时可配置
usage_mode 必填 string
【使用模式】 商品券使用模式
可选取值
SINGLE: 单券,即用户只能使用一次,使用后券失效SEQUENTIAL: 多次优惠,即用户可以按顺序多次使用,每次核销成功后会发放下一次优惠机会,直到用完为止
single_usage_info 选填 object
【单券模式信息】 单券模式配置信息,当且仅当 usage_mode 为 SINGLE 时选填(是否填写取决于是否需要填写内部字段),其他模式不应填写。
| 属性 | |||||||||
normal_coupon 选填 object 【满减券使用规则】 本商品券内所有批次均以此规则提供满减优惠,当且仅当
discount_coupon 选填 object 【折扣券使用规则】 本商品券内所有批次均以此规则提供折扣优惠,当且仅当
|
sequential_usage_info 选填 object
【多次优惠模式信息】 多次优惠模式配置信息,当且仅当 usage_mode 为 SEQUENTIAL 时必传,其他模式不应填写。
| 属性 | |
type 必填 string 【多次优惠规则类型】 多次优惠规则类型 可选取值
count 必填 integer 【可使用次数】 本多次优惠领取后用户可使用次数,最多15次 available_days 必填 integer 【多次优惠有效天数】 用户的多次优惠生效后 N 天内有效,最少3天,最多365天 interval_days 选填 integer 【多次优惠使用间隔天数】 多次优惠多次使用之间需要间隔的天数,最高7天。例如:
默认情况下为 |
display_info 必填 object
【展示信息】 商品券展示信息,展示结果可参考商品券示意图
| 属性 | |||||||||
name 必填 string(15) 【商品券名称】 商品券名称,长度为3-15个UTF-8字符 image_url 必填 string 【商品券图片】 商品图片的链接地址,仅支持通过图片上传接口获取的图片URL地址。
background_url 必填 string 【商品券背景图】 商品背景图片的URL地址,仅支持通过图片上传接口获取的图片URL地址。
detail_image_url_list 选填 array[string] 【商品券详情图列表】 商品详情图URL地址列表,用于最多可上传8张图片,仅支持通过图片上传接口获取的图片URL地址。
original_price 选填 integer 【商品原价】 单位为分,当且仅当 combo_package_list 选填 array[object] 【套餐组合】 当
|
out_product_no 选填 string(40)
【外部商品ID】 品牌侧的商品标识,品牌可自行选择传入,长度不超过40个字符。
注:微信支付不校验此参数的唯一性,即允许多个商品券共享外部商品ID。
stock 必填 object
【批次】 商品券批次信息
| 属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
remark 选填 string(20) 【备注】 仅配置品牌方可见,用于自定义信息,最多20个UTF-8字符 coupon_code_mode 必填 string 【券Code分配模式】 决定发券时用户商品券Code如何产生 可选取值
stock_send_rule 必填 object 【发放规则】 批次的发放规则
single_usage_rule 选填 object 【单券使用规则】 当且仅当
sequential_usage_rule 选填 object 【多次优惠使用规则】 当且仅当
usage_rule_display_info 必填 object 【券使用规则展示信息】 券使用规则展示信息
coupon_display_info 必填 object 【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
notify_config 必填 object 【事件通知配置】 发生券相关事件时,微信支付会向品牌方发送通知,需要提供通知相关配置
store_scope 必填 string 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
|
请求示例
POST
创建满100可用的全场8折券
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/product-coupon/product-coupons \ 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_product_no" : "Product_1234567890", 9 "scope" : "ALL", 10 "usage_mode" : "SINGLE", 11 "display_info" : { 12 "name" : "全场满100立打8折", 13 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 14 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 15 "detail_image_url_list" : [ 16 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 17 ] 18 }, 19 "single_usage_info" : { 20 "discount_coupon" : { 21 "threshold" : 10000, 22 "percent_off" : 20 23 } 24 }, 25 "type" : "DISCOUNT", 26 "stock" : { 27 "remark" : "8月工作日有效批次", 28 "coupon_code_mode" : "UPLOAD", 29 "stock_send_rule" : { 30 "max_count" : 10000000, 31 "max_count_per_user" : 1 32 }, 33 "single_usage_rule" : { 34 "coupon_available_period" : { 35 "available_begin_time" : "2025-08-01T00:00:00+08:00", 36 "available_end_time" : "2025-08-31T23:59:59+08:00", 37 "available_days" : 30, 38 "weekly_available_period" : { 39 "day_list" : [ 40 "MONDAY", 41 "TUESDAY", 42 "WEDNESDAY", 43 "THURSDAY", 44 "FRIDAY" 45 ] 46 } 47 } 48 }, 49 "usage_rule_display_info" : { 50 "coupon_usage_method_list" : [ 51 "OFFLINE", 52 "MINI_PROGRAM", 53 "PAYMENT_CODE" 54 ], 55 "mini_program_appid" : "wx1234567890", 56 "mini_program_path" : "/pages/index/product", 57 "usage_description" : "工作日可用", 58 "coupon_available_store_info" : { 59 "description" : "所有门店可用,可使用小程序查看门店列表", 60 "mini_program_appid" : "wx1234567890", 61 "mini_program_path" : "/pages/index/store-list" 62 } 63 }, 64 "coupon_display_info" : { 65 "code_display_mode" : "QRCODE", 66 "background_color" : "Color010", 67 "entrance_mini_program" : { 68 "appid" : "wx1234567890", 69 "path" : "/pages/index/product", 70 "entrance_wording" : "欢迎选购", 71 "guidance_wording" : "获取更多优惠" 72 }, 73 "entrance_official_account" : { 74 "appid" : "wx1234567890" 75 }, 76 "entrance_finder" : { 77 "finder_id" : "gh_12345678", 78 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 79 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 80 } 81 }, 82 "store_scope" : "NONE", 83 "notify_config" : { 84 "notify_appid" : "wx4fd12345678" 85 } 86 }, 87 "out_request_no" : "12345_20250101_A3489" 88 }' 89
需配合微信支付工具库 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 CreateProductCoupon { 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"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 CreateProductCoupon client = new CreateProductCoupon( 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 CreateProductCouponRequest request = new CreateProductCouponRequest(); 41 request.outRequestNo = "12345_20250101_A3489"; 42 request.scope = ProductCouponScope.ALL; 43 request.type = ProductCouponType.DISCOUNT; 44 request.usageMode = UsageMode.SINGLE; 45 request.singleUsageInfo = new SingleUsageInfo(); 46 request.singleUsageInfo.discountCoupon = new DiscountCouponUsageRule(); 47 request.singleUsageInfo.discountCoupon.threshold = 10000L; 48 request.singleUsageInfo.discountCoupon.percentOff = 20L; 49 request.displayInfo = new ProductCouponDisplayInfo(); 50 request.displayInfo.name = "全场满100立打8折"; 51 request.displayInfo.imageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 52 request.displayInfo.backgroundUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 53 request.displayInfo.detailImageUrlList = new ArrayList<>(); 54 { 55 request.displayInfo.detailImageUrlList.add("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"); 56 }; 57 request.outProductNo = "Product_1234567890"; 58 request.stock = new StockForCreate(); 59 request.stock.remark = "8月工作日有效批次"; 60 request.stock.couponCodeMode = CouponCodeMode.UPLOAD; 61 request.stock.stockSendRule = new StockSendRule(); 62 request.stock.stockSendRule.maxCount = 10000000L; 63 request.stock.stockSendRule.maxCountPerUser = 1L; 64 request.stock.singleUsageRule = new SingleUsageRule(); 65 request.stock.singleUsageRule.couponAvailablePeriod = new SingleCouponAvailablePeriod(); 66 request.stock.singleUsageRule.couponAvailablePeriod.availableBeginTime = "2025-08-01T00:00:00+08:00"; 67 request.stock.singleUsageRule.couponAvailablePeriod.availableEndTime = "2025-08-31T23:59:59+08:00"; 68 request.stock.singleUsageRule.couponAvailablePeriod.availableDays = 30L; 69 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod = new FixedWeekPeriod(); 70 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList = new ArrayList<>(); 71 { 72 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.MONDAY); 73 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.TUESDAY); 74 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.WEDNESDAY); 75 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.THURSDAY); 76 request.stock.singleUsageRule.couponAvailablePeriod.weeklyAvailablePeriod.dayList.add(WeekEnum.FRIDAY); 77 }; 78 request.stock.usageRuleDisplayInfo = new UsageRuleDisplayInfo(); 79 request.stock.usageRuleDisplayInfo.couponUsageMethodList = new ArrayList<>(); 80 { 81 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.OFFLINE); 82 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.MINI_PROGRAM); 83 request.stock.usageRuleDisplayInfo.couponUsageMethodList.add(CouponUsageMethod.PAYMENT_CODE); 84 }; 85 request.stock.usageRuleDisplayInfo.miniProgramAppid = "wx1234567890"; 86 request.stock.usageRuleDisplayInfo.miniProgramPath = "/pages/index/product"; 87 request.stock.usageRuleDisplayInfo.usageDescription = "工作日可用"; 88 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo = new CouponAvailableStoreInfo(); 89 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.description = "所有门店可用,可使用小程序查看门店列表"; 90 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramAppid = "wx1234567890"; 91 request.stock.usageRuleDisplayInfo.couponAvailableStoreInfo.miniProgramPath = "/pages/index/store-list"; 92 request.stock.couponDisplayInfo = new CouponDisplayInfo(); 93 request.stock.couponDisplayInfo.codeDisplayMode = CouponCodeDisplayMode.QRCODE; 94 request.stock.couponDisplayInfo.backgroundColor = "Color010"; 95 request.stock.couponDisplayInfo.entranceMiniProgram = new EntranceMiniProgram(); 96 request.stock.couponDisplayInfo.entranceMiniProgram.appid = "wx1234567890"; 97 request.stock.couponDisplayInfo.entranceMiniProgram.path = "/pages/index/product"; 98 request.stock.couponDisplayInfo.entranceMiniProgram.entranceWording = "欢迎选购"; 99 request.stock.couponDisplayInfo.entranceMiniProgram.guidanceWording = "获取更多优惠"; 100 request.stock.couponDisplayInfo.entranceOfficialAccount = new EntranceOfficialAccount(); 101 request.stock.couponDisplayInfo.entranceOfficialAccount.appid = "wx1234567890"; 102 request.stock.couponDisplayInfo.entranceFinder = new EntranceFinder(); 103 request.stock.couponDisplayInfo.entranceFinder.finderId = "gh_12345678"; 104 request.stock.couponDisplayInfo.entranceFinder.finderVideoId = "UDFsdf24df34dD456Hdf34"; 105 request.stock.couponDisplayInfo.entranceFinder.finderVideoCoverImageUrl = "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"; 106 request.stock.notifyConfig = new NotifyConfig(); 107 request.stock.notifyConfig.notifyAppid = "wx4fd12345678"; 108 request.stock.storeScope = StockStoreScope.NONE; 109 try { 110 CreateProductCouponResponse response = client.run(request); 111 // TODO: 请求成功,继续业务逻辑 112 System.out.println(response); 113 } catch (WXPayBrandUtility.ApiException e) { 114 // TODO: 请求失败,根据状态码执行不同的逻辑 115 e.printStackTrace(); 116 } 117 } 118 119 public CreateProductCouponResponse run(CreateProductCouponRequest request) { 120 String uri = PATH; 121 String reqBody = WXPayBrandUtility.toJson(request); 122 123 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 124 reqBuilder.addHeader("Accept", "application/json"); 125 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 126 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 127 reqBuilder.addHeader("Content-Type", "application/json"); 128 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 129 reqBuilder.method(METHOD, requestBody); 130 Request httpRequest = reqBuilder.build(); 131 132 // 发送HTTP请求 133 OkHttpClient client = new OkHttpClient.Builder().build(); 134 try (Response httpResponse = client.newCall(httpRequest).execute()) { 135 String respBody = WXPayBrandUtility.extractBody(httpResponse); 136 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 137 // 2XX 成功,验证应答签名 138 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 139 httpResponse.headers(), respBody); 140 141 // 从HTTP应答报文构建返回数据 142 return WXPayBrandUtility.fromJson(respBody, CreateProductCouponResponse.class); 143 } else { 144 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 145 } 146 } catch (IOException e) { 147 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 148 } 149 } 150 151 private final String brand_id; 152 private final String certificateSerialNo; 153 private final PrivateKey privateKey; 154 private final String wechatPayPublicKeyId; 155 private final PublicKey wechatPayPublicKey; 156 157 public CreateProductCoupon(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 158 this.brand_id = brand_id; 159 this.certificateSerialNo = certificateSerialNo; 160 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 161 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 162 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 163 } 164 165 public static class CreateProductCouponRequest { 166 @SerializedName("out_request_no") 167 public String outRequestNo; 168 169 @SerializedName("scope") 170 public ProductCouponScope scope; 171 172 @SerializedName("type") 173 public ProductCouponType type; 174 175 @SerializedName("usage_mode") 176 public UsageMode usageMode; 177 178 @SerializedName("single_usage_info") 179 public SingleUsageInfo singleUsageInfo; 180 181 @SerializedName("sequential_usage_info") 182 public SequentialUsageInfo sequentialUsageInfo; 183 184 @SerializedName("display_info") 185 public ProductCouponDisplayInfo displayInfo; 186 187 @SerializedName("out_product_no") 188 public String outProductNo; 189 190 @SerializedName("stock") 191 public StockForCreate stock; 192 } 193 194 public static class CreateProductCouponResponse { 195 @SerializedName("product_coupon_id") 196 public String productCouponId; 197 198 @SerializedName("scope") 199 public ProductCouponScope scope; 200 201 @SerializedName("type") 202 public ProductCouponType type; 203 204 @SerializedName("usage_mode") 205 public UsageMode usageMode; 206 207 @SerializedName("single_usage_info") 208 public SingleUsageInfo singleUsageInfo; 209 210 @SerializedName("sequential_usage_info") 211 public SequentialUsageInfo sequentialUsageInfo; 212 213 @SerializedName("display_info") 214 public ProductCouponDisplayInfo displayInfo; 215 216 @SerializedName("out_product_no") 217 public String outProductNo; 218 219 @SerializedName("state") 220 public ProductCouponState state; 221 222 @SerializedName("stock") 223 public StockEntity stock; 224 } 225 226 public enum ProductCouponScope { 227 @SerializedName("ALL") 228 ALL, 229 @SerializedName("SINGLE") 230 SINGLE 231 } 232 233 public enum ProductCouponType { 234 @SerializedName("NORMAL") 235 NORMAL, 236 @SerializedName("DISCOUNT") 237 DISCOUNT, 238 @SerializedName("EXCHANGE") 239 EXCHANGE 240 } 241 242 public enum UsageMode { 243 @SerializedName("SINGLE") 244 SINGLE, 245 @SerializedName("SEQUENTIAL") 246 SEQUENTIAL 247 } 248 249 public static class SingleUsageInfo { 250 @SerializedName("normal_coupon") 251 public NormalCouponUsageRule normalCoupon; 252 253 @SerializedName("discount_coupon") 254 public DiscountCouponUsageRule discountCoupon; 255 } 256 257 public static class SequentialUsageInfo { 258 @SerializedName("type") 259 public SequentialUsageType type; 260 261 @SerializedName("count") 262 public Long count; 263 264 @SerializedName("available_days") 265 public Long availableDays; 266 267 @SerializedName("interval_days") 268 public Long intervalDays; 269 } 270 271 public static class ProductCouponDisplayInfo { 272 @SerializedName("name") 273 public String name; 274 275 @SerializedName("image_url") 276 public String imageUrl; 277 278 @SerializedName("background_url") 279 public String backgroundUrl; 280 281 @SerializedName("detail_image_url_list") 282 public List<String> detailImageUrlList; 283 284 @SerializedName("original_price") 285 public Long originalPrice; 286 287 @SerializedName("combo_package_list") 288 public List<ComboPackage> comboPackageList; 289 } 290 291 public static class StockForCreate { 292 @SerializedName("remark") 293 public String remark; 294 295 @SerializedName("coupon_code_mode") 296 public CouponCodeMode couponCodeMode; 297 298 @SerializedName("stock_send_rule") 299 public StockSendRule stockSendRule; 300 301 @SerializedName("single_usage_rule") 302 public SingleUsageRule singleUsageRule; 303 304 @SerializedName("sequential_usage_rule") 305 public SequentialUsageRule sequentialUsageRule; 306 307 @SerializedName("usage_rule_display_info") 308 public UsageRuleDisplayInfo usageRuleDisplayInfo; 309 310 @SerializedName("coupon_display_info") 311 public CouponDisplayInfo couponDisplayInfo; 312 313 @SerializedName("notify_config") 314 public NotifyConfig notifyConfig; 315 316 @SerializedName("store_scope") 317 public StockStoreScope storeScope; 318 } 319 320 public enum ProductCouponState { 321 @SerializedName("AUDITING") 322 AUDITING, 323 @SerializedName("EFFECTIVE") 324 EFFECTIVE, 325 @SerializedName("DEACTIVATED") 326 DEACTIVATED 327 } 328 329 public static class StockEntity { 330 @SerializedName("product_coupon_id") 331 public String productCouponId; 332 333 @SerializedName("stock_id") 334 public String stockId; 335 336 @SerializedName("remark") 337 public String remark; 338 339 @SerializedName("coupon_code_mode") 340 public CouponCodeMode couponCodeMode; 341 342 @SerializedName("coupon_code_count_info") 343 public CouponCodeCountInfo couponCodeCountInfo; 344 345 @SerializedName("stock_send_rule") 346 public StockSendRule stockSendRule; 347 348 @SerializedName("single_usage_rule") 349 public SingleUsageRule singleUsageRule; 350 351 @SerializedName("sequential_usage_rule") 352 public SequentialUsageRule sequentialUsageRule; 353 354 @SerializedName("usage_rule_display_info") 355 public UsageRuleDisplayInfo usageRuleDisplayInfo; 356 357 @SerializedName("coupon_display_info") 358 public CouponDisplayInfo couponDisplayInfo; 359 360 @SerializedName("notify_config") 361 public NotifyConfig notifyConfig; 362 363 @SerializedName("store_scope") 364 public StockStoreScope storeScope; 365 366 @SerializedName("sent_count_info") 367 public StockSentCountInfo sentCountInfo; 368 369 @SerializedName("state") 370 public StockState state; 371 372 @SerializedName("deactivate_request_no") 373 public String deactivateRequestNo; 374 375 @SerializedName("deactivate_time") 376 public String deactivateTime; 377 378 @SerializedName("deactivate_reason") 379 public String deactivateReason; 380 } 381 382 public static class NormalCouponUsageRule { 383 @SerializedName("threshold") 384 public Long threshold; 385 386 @SerializedName("discount_amount") 387 public Long discountAmount; 388 } 389 390 public static class DiscountCouponUsageRule { 391 @SerializedName("threshold") 392 public Long threshold; 393 394 @SerializedName("percent_off") 395 public Long percentOff; 396 } 397 398 public enum SequentialUsageType { 399 @SerializedName("INCREMENTAL") 400 INCREMENTAL, 401 @SerializedName("EQUAL") 402 EQUAL 403 } 404 405 public static class ComboPackage { 406 @SerializedName("name") 407 public String name; 408 409 @SerializedName("pick_count") 410 public Long pickCount; 411 412 @SerializedName("choice_list") 413 public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>(); 414 } 415 416 public enum CouponCodeMode { 417 @SerializedName("WECHATPAY") 418 WECHATPAY, 419 @SerializedName("UPLOAD") 420 UPLOAD, 421 @SerializedName("API_ASSIGN") 422 API_ASSIGN 423 } 424 425 public static class StockSendRule { 426 @SerializedName("max_count") 427 public Long maxCount; 428 429 @SerializedName("max_count_per_day") 430 public Long maxCountPerDay; 431 432 @SerializedName("max_count_per_user") 433 public Long maxCountPerUser; 434 } 435 436 public static class SingleUsageRule { 437 @SerializedName("coupon_available_period") 438 public SingleCouponAvailablePeriod couponAvailablePeriod; 439 440 @SerializedName("normal_coupon") 441 public NormalCouponUsageRule normalCoupon; 442 443 @SerializedName("discount_coupon") 444 public DiscountCouponUsageRule discountCoupon; 445 446 @SerializedName("exchange_coupon") 447 public ExchangeCouponUsageRule exchangeCoupon; 448 } 449 450 public static class SequentialUsageRule { 451 @SerializedName("coupon_available_period") 452 public SequentialCouponAvailablePeriod couponAvailablePeriod; 453 454 @SerializedName("normal_coupon_list") 455 public List<NormalCouponUsageRule> normalCouponList; 456 457 @SerializedName("discount_coupon_list") 458 public List<DiscountCouponUsageRule> discountCouponList; 459 460 @SerializedName("exchange_coupon_list") 461 public List<ExchangeCouponUsageRule> exchangeCouponList; 462 463 @SerializedName("special_first") 464 public Boolean specialFirst; 465 } 466 467 public static class UsageRuleDisplayInfo { 468 @SerializedName("coupon_usage_method_list") 469 public List<CouponUsageMethod> couponUsageMethodList = new ArrayList<CouponUsageMethod>(); 470 471 @SerializedName("mini_program_appid") 472 public String miniProgramAppid; 473 474 @SerializedName("mini_program_path") 475 public String miniProgramPath; 476 477 @SerializedName("app_path") 478 public String appPath; 479 480 @SerializedName("usage_description") 481 public String usageDescription; 482 483 @SerializedName("coupon_available_store_info") 484 public CouponAvailableStoreInfo couponAvailableStoreInfo; 485 } 486 487 public static class CouponDisplayInfo { 488 @SerializedName("code_display_mode") 489 public CouponCodeDisplayMode codeDisplayMode; 490 491 @SerializedName("background_color") 492 public String backgroundColor; 493 494 @SerializedName("entrance_mini_program") 495 public EntranceMiniProgram entranceMiniProgram; 496 497 @SerializedName("entrance_official_account") 498 public EntranceOfficialAccount entranceOfficialAccount; 499 500 @SerializedName("entrance_finder") 501 public EntranceFinder entranceFinder; 502 } 503 504 public static class NotifyConfig { 505 @SerializedName("notify_appid") 506 public String notifyAppid; 507 } 508 509 public enum StockStoreScope { 510 @SerializedName("NONE") 511 NONE, 512 @SerializedName("ALL") 513 ALL, 514 @SerializedName("SPECIFIC") 515 SPECIFIC 516 } 517 518 public static class CouponCodeCountInfo { 519 @SerializedName("total_count") 520 public Long totalCount; 521 522 @SerializedName("available_count") 523 public Long availableCount; 524 } 525 526 public static class StockSentCountInfo { 527 @SerializedName("total_count") 528 public Long totalCount; 529 530 @SerializedName("today_count") 531 public Long todayCount; 532 } 533 534 public enum StockState { 535 @SerializedName("AUDITING") 536 AUDITING, 537 @SerializedName("SENDING") 538 SENDING, 539 @SerializedName("PAUSED") 540 PAUSED, 541 @SerializedName("STOPPED") 542 STOPPED, 543 @SerializedName("DEACTIVATED") 544 DEACTIVATED 545 } 546 547 public static class ComboPackageChoice { 548 @SerializedName("name") 549 public String name; 550 551 @SerializedName("price") 552 public Long price; 553 554 @SerializedName("count") 555 public Long count; 556 557 @SerializedName("image_url") 558 public String imageUrl; 559 560 @SerializedName("mini_program_appid") 561 public String miniProgramAppid; 562 563 @SerializedName("mini_program_path") 564 public String miniProgramPath; 565 } 566 567 public static class SingleCouponAvailablePeriod { 568 @SerializedName("available_begin_time") 569 public String availableBeginTime; 570 571 @SerializedName("available_end_time") 572 public String availableEndTime; 573 574 @SerializedName("available_days") 575 public Long availableDays; 576 577 @SerializedName("wait_days_after_receive") 578 public Long waitDaysAfterReceive; 579 580 @SerializedName("weekly_available_period") 581 public FixedWeekPeriod weeklyAvailablePeriod; 582 583 @SerializedName("irregular_available_period_list") 584 public List<TimePeriod> irregularAvailablePeriodList; 585 } 586 587 public static class ExchangeCouponUsageRule { 588 @SerializedName("threshold") 589 public Long threshold; 590 591 @SerializedName("exchange_price") 592 public Long exchangePrice; 593 } 594 595 public static class SequentialCouponAvailablePeriod { 596 @SerializedName("available_begin_time") 597 public String availableBeginTime; 598 599 @SerializedName("available_end_time") 600 public String availableEndTime; 601 602 @SerializedName("wait_days_after_receive") 603 public Long waitDaysAfterReceive; 604 605 @SerializedName("weekly_available_period") 606 public FixedWeekPeriod weeklyAvailablePeriod; 607 608 @SerializedName("irregular_available_period_list") 609 public List<TimePeriod> irregularAvailablePeriodList; 610 } 611 612 public enum CouponUsageMethod { 613 @SerializedName("OFFLINE") 614 OFFLINE, 615 @SerializedName("MINI_PROGRAM") 616 MINI_PROGRAM, 617 @SerializedName("APP") 618 APP, 619 @SerializedName("PAYMENT_CODE") 620 PAYMENT_CODE 621 } 622 623 public static class CouponAvailableStoreInfo { 624 @SerializedName("description") 625 public String description; 626 627 @SerializedName("mini_program_appid") 628 public String miniProgramAppid; 629 630 @SerializedName("mini_program_path") 631 public String miniProgramPath; 632 } 633 634 public enum CouponCodeDisplayMode { 635 @SerializedName("INVISIBLE") 636 INVISIBLE, 637 @SerializedName("BARCODE") 638 BARCODE, 639 @SerializedName("QRCODE") 640 QRCODE 641 } 642 643 public static class EntranceMiniProgram { 644 @SerializedName("appid") 645 public String appid; 646 647 @SerializedName("path") 648 public String path; 649 650 @SerializedName("entrance_wording") 651 public String entranceWording; 652 653 @SerializedName("guidance_wording") 654 public String guidanceWording; 655 } 656 657 public static class EntranceOfficialAccount { 658 @SerializedName("appid") 659 public String appid; 660 } 661 662 public static class EntranceFinder { 663 @SerializedName("finder_id") 664 public String finderId; 665 666 @SerializedName("finder_video_id") 667 public String finderVideoId; 668 669 @SerializedName("finder_video_cover_image_url") 670 public String finderVideoCoverImageUrl; 671 } 672 673 public static class FixedWeekPeriod { 674 @SerializedName("day_list") 675 public List<WeekEnum> dayList; 676 677 @SerializedName("day_period_list") 678 public List<PeriodOfTheDay> dayPeriodList; 679 } 680 681 public static class TimePeriod { 682 @SerializedName("begin_time") 683 public String beginTime; 684 685 @SerializedName("end_time") 686 public String endTime; 687 } 688 689 public enum WeekEnum { 690 @SerializedName("MONDAY") 691 MONDAY, 692 @SerializedName("TUESDAY") 693 TUESDAY, 694 @SerializedName("WEDNESDAY") 695 WEDNESDAY, 696 @SerializedName("THURSDAY") 697 THURSDAY, 698 @SerializedName("FRIDAY") 699 FRIDAY, 700 @SerializedName("SATURDAY") 701 SATURDAY, 702 @SerializedName("SUNDAY") 703 SUNDAY 704 } 705 706 public static class PeriodOfTheDay { 707 @SerializedName("begin_time") 708 public Long beginTime; 709 710 @SerializedName("end_time") 711 public Long endTime; 712 } 713 714} 715
需配合微信支付工具库 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 "time" 11) 12 13func main() { 14 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 15 config, err := wxpay_brand_utility.CreateBrandConfig( 16 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 17 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 18 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &CreateProductCouponRequest{ 28 OutRequestNo: wxpay_brand_utility.String("12345_20250101_A3489"), 29 Scope: PRODUCTCOUPONSCOPE_ALL.Ptr(), 30 Type: PRODUCTCOUPONTYPE_DISCOUNT.Ptr(), 31 UsageMode: USAGEMODE_SINGLE.Ptr(), 32 SingleUsageInfo: &SingleUsageInfo{ 33 DiscountCoupon: &DiscountCouponUsageRule{ 34 Threshold: wxpay_brand_utility.Int64(10000), 35 PercentOff: wxpay_brand_utility.Int64(20), 36 }, 37 }, 38 DisplayInfo: &ProductCouponDisplayInfo{ 39 Name: wxpay_brand_utility.String("全场满100立打8折"), 40 ImageUrl: wxpay_brand_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 41 BackgroundUrl: wxpay_brand_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 42 DetailImageUrlList: []string{ 43 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 44 }, 45 }, 46 OutProductNo: wxpay_brand_utility.String("Product_1234567890"), 47 Stock: &StockForCreate{ 48 Remark: wxpay_brand_utility.String("8月工作日有效批次"), 49 CouponCodeMode: COUPONCODEMODE_UPLOAD.Ptr(), 50 StockSendRule: &StockSendRule{ 51 MaxCount: wxpay_brand_utility.Int64(10000000), 52 MaxCountPerUser: wxpay_brand_utility.Int64(1), 53 }, 54 SingleUsageRule: &SingleUsageRule{ 55 CouponAvailablePeriod: &SingleCouponAvailablePeriod{ 56 AvailableBeginTime: wxpay_brand_utility.String("2025-08-01T00:00:00+08:00"), 57 AvailableEndTime: wxpay_brand_utility.String("2025-08-31T23:59:59+08:00"), 58 AvailableDays: wxpay_brand_utility.Int64(30), 59 WeeklyAvailablePeriod: &FixedWeekPeriod{ 60 DayList: []WeekEnum{ 61 WEEKENUM_MONDAY, 62 WEEKENUM_TUESDAY, 63 WEEKENUM_WEDNESDAY, 64 WEEKENUM_THURSDAY, 65 WEEKENUM_FRIDAY, 66 }, 67 }, 68 }, 69 }, 70 UsageRuleDisplayInfo: &UsageRuleDisplayInfo{ 71 CouponUsageMethodList: []CouponUsageMethod{ 72 COUPONUSAGEMETHOD_OFFLINE, 73 COUPONUSAGEMETHOD_MINI_PROGRAM, 74 COUPONUSAGEMETHOD_PAYMENT_CODE, 75 }, 76 MiniProgramAppid: wxpay_brand_utility.String("wx1234567890"), 77 MiniProgramPath: wxpay_brand_utility.String("/pages/index/product"), 78 UsageDescription: wxpay_brand_utility.String("工作日可用"), 79 CouponAvailableStoreInfo: &CouponAvailableStoreInfo{ 80 Description: wxpay_brand_utility.String("所有门店可用,可使用小程序查看门店列表"), 81 MiniProgramAppid: wxpay_brand_utility.String("wx1234567890"), 82 MiniProgramPath: wxpay_brand_utility.String("/pages/index/store-list"), 83 }, 84 }, 85 CouponDisplayInfo: &CouponDisplayInfo{ 86 CodeDisplayMode: COUPONCODEDISPLAYMODE_QRCODE.Ptr(), 87 BackgroundColor: wxpay_brand_utility.String("Color010"), 88 EntranceMiniProgram: &EntranceMiniProgram{ 89 Appid: wxpay_brand_utility.String("wx1234567890"), 90 Path: wxpay_brand_utility.String("/pages/index/product"), 91 EntranceWording: wxpay_brand_utility.String("欢迎选购"), 92 GuidanceWording: wxpay_brand_utility.String("获取更多优惠"), 93 }, 94 EntranceOfficialAccount: &EntranceOfficialAccount{ 95 Appid: wxpay_brand_utility.String("wx1234567890"), 96 }, 97 EntranceFinder: &EntranceFinder{ 98 FinderId: wxpay_brand_utility.String("gh_12345678"), 99 FinderVideoId: wxpay_brand_utility.String("UDFsdf24df34dD456Hdf34"), 100 FinderVideoCoverImageUrl: wxpay_brand_utility.String("https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx"), 101 }, 102 }, 103 NotifyConfig: &NotifyConfig{ 104 NotifyAppid: wxpay_brand_utility.String("wx4fd12345678"), 105 }, 106 StoreScope: STOCKSTORESCOPE_NONE.Ptr(), 107 }, 108 } 109 110 response, err := CreateProductCoupon(config, request) 111 if err != nil { 112 fmt.Printf("请求失败: %+v\n", err) 113 // TODO: 请求失败,根据状态码执行不同的处理 114 return 115 } 116 117 // TODO: 请求成功,继续业务逻辑 118 fmt.Printf("请求成功: %+v\n", response) 119} 120 121func CreateProductCoupon(config *wxpay_brand_utility.BrandConfig, request *CreateProductCouponRequest) (response *CreateProductCouponResponse, err error) { 122 const ( 123 host = "https://api.mch.weixin.qq.com" 124 method = "POST" 125 path = "/brand/marketing/product-coupon/product-coupons" 126 ) 127 128 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 129 if err != nil { 130 return nil, err 131 } 132 reqBody, err := json.Marshal(request) 133 if err != nil { 134 return nil, err 135 } 136 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 137 if err != nil { 138 return nil, err 139 } 140 httpRequest.Header.Set("Accept", "application/json") 141 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 142 httpRequest.Header.Set("Content-Type", "application/json") 143 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 144 if err != nil { 145 return nil, err 146 } 147 httpRequest.Header.Set("Authorization", authorization) 148 149 client := &http.Client{} 150 httpResponse, err := client.Do(httpRequest) 151 if err != nil { 152 return nil, err 153 } 154 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 155 if err != nil { 156 return nil, err 157 } 158 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 159 // 2XX 成功,验证应答签名 160 err = wxpay_brand_utility.ValidateResponse( 161 config.WechatPayPublicKeyId(), 162 config.WechatPayPublicKey(), 163 &httpResponse.Header, 164 respBody, 165 ) 166 if err != nil { 167 return nil, err 168 } 169 response := &CreateProductCouponResponse{} 170 if err := json.Unmarshal(respBody, response); err != nil { 171 return nil, err 172 } 173 174 return response, nil 175 } else { 176 return nil, wxpay_brand_utility.NewApiException( 177 httpResponse.StatusCode, 178 httpResponse.Header, 179 respBody, 180 ) 181 } 182} 183 184type CreateProductCouponRequest struct { 185 OutRequestNo *string `json:"out_request_no,omitempty"` 186 Scope *ProductCouponScope `json:"scope,omitempty"` 187 Type *ProductCouponType `json:"type,omitempty"` 188 UsageMode *UsageMode `json:"usage_mode,omitempty"` 189 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 190 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 191 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 192 OutProductNo *string `json:"out_product_no,omitempty"` 193 Stock *StockForCreate `json:"stock,omitempty"` 194} 195 196type CreateProductCouponResponse struct { 197 ProductCouponId *string `json:"product_coupon_id,omitempty"` 198 Scope *ProductCouponScope `json:"scope,omitempty"` 199 Type *ProductCouponType `json:"type,omitempty"` 200 UsageMode *UsageMode `json:"usage_mode,omitempty"` 201 SingleUsageInfo *SingleUsageInfo `json:"single_usage_info,omitempty"` 202 SequentialUsageInfo *SequentialUsageInfo `json:"sequential_usage_info,omitempty"` 203 DisplayInfo *ProductCouponDisplayInfo `json:"display_info,omitempty"` 204 OutProductNo *string `json:"out_product_no,omitempty"` 205 State *ProductCouponState `json:"state,omitempty"` 206 Stock *StockEntity `json:"stock,omitempty"` 207} 208 209type ProductCouponScope string 210 211func (e ProductCouponScope) Ptr() *ProductCouponScope { 212 return &e 213} 214 215const ( 216 PRODUCTCOUPONSCOPE_ALL ProductCouponScope = "ALL" 217 PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE" 218) 219 220type ProductCouponType string 221 222func (e ProductCouponType) Ptr() *ProductCouponType { 223 return &e 224} 225 226const ( 227 PRODUCTCOUPONTYPE_NORMAL ProductCouponType = "NORMAL" 228 PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT" 229 PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE" 230) 231 232type UsageMode string 233 234func (e UsageMode) Ptr() *UsageMode { 235 return &e 236} 237 238const ( 239 USAGEMODE_SINGLE UsageMode = "SINGLE" 240 USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL" 241) 242 243type SingleUsageInfo struct { 244 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 245 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 246} 247 248type SequentialUsageInfo struct { 249 Type *SequentialUsageType `json:"type,omitempty"` 250 Count *int64 `json:"count,omitempty"` 251 AvailableDays *int64 `json:"available_days,omitempty"` 252 IntervalDays *int64 `json:"interval_days,omitempty"` 253} 254 255type ProductCouponDisplayInfo struct { 256 Name *string `json:"name,omitempty"` 257 ImageUrl *string `json:"image_url,omitempty"` 258 BackgroundUrl *string `json:"background_url,omitempty"` 259 DetailImageUrlList []string `json:"detail_image_url_list,omitempty"` 260 OriginalPrice *int64 `json:"original_price,omitempty"` 261 ComboPackageList []ComboPackage `json:"combo_package_list,omitempty"` 262} 263 264type StockForCreate struct { 265 Remark *string `json:"remark,omitempty"` 266 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 267 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 268 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 269 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 270 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 271 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 272 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 273 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 274} 275 276type ProductCouponState string 277 278func (e ProductCouponState) Ptr() *ProductCouponState { 279 return &e 280} 281 282const ( 283 PRODUCTCOUPONSTATE_AUDITING ProductCouponState = "AUDITING" 284 PRODUCTCOUPONSTATE_EFFECTIVE ProductCouponState = "EFFECTIVE" 285 PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED" 286) 287 288type StockEntity struct { 289 ProductCouponId *string `json:"product_coupon_id,omitempty"` 290 StockId *string `json:"stock_id,omitempty"` 291 Remark *string `json:"remark,omitempty"` 292 CouponCodeMode *CouponCodeMode `json:"coupon_code_mode,omitempty"` 293 CouponCodeCountInfo *CouponCodeCountInfo `json:"coupon_code_count_info,omitempty"` 294 StockSendRule *StockSendRule `json:"stock_send_rule,omitempty"` 295 SingleUsageRule *SingleUsageRule `json:"single_usage_rule,omitempty"` 296 SequentialUsageRule *SequentialUsageRule `json:"sequential_usage_rule,omitempty"` 297 UsageRuleDisplayInfo *UsageRuleDisplayInfo `json:"usage_rule_display_info,omitempty"` 298 CouponDisplayInfo *CouponDisplayInfo `json:"coupon_display_info,omitempty"` 299 NotifyConfig *NotifyConfig `json:"notify_config,omitempty"` 300 StoreScope *StockStoreScope `json:"store_scope,omitempty"` 301 SentCountInfo *StockSentCountInfo `json:"sent_count_info,omitempty"` 302 State *StockState `json:"state,omitempty"` 303 DeactivateRequestNo *string `json:"deactivate_request_no,omitempty"` 304 DeactivateTime *time.Time `json:"deactivate_time,omitempty"` 305 DeactivateReason *string `json:"deactivate_reason,omitempty"` 306} 307 308type NormalCouponUsageRule struct { 309 Threshold *int64 `json:"threshold,omitempty"` 310 DiscountAmount *int64 `json:"discount_amount,omitempty"` 311} 312 313type DiscountCouponUsageRule struct { 314 Threshold *int64 `json:"threshold,omitempty"` 315 PercentOff *int64 `json:"percent_off,omitempty"` 316} 317 318type SequentialUsageType string 319 320func (e SequentialUsageType) Ptr() *SequentialUsageType { 321 return &e 322} 323 324const ( 325 SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL" 326 SEQUENTIALUSAGETYPE_EQUAL SequentialUsageType = "EQUAL" 327) 328 329type ComboPackage struct { 330 Name *string `json:"name,omitempty"` 331 PickCount *int64 `json:"pick_count,omitempty"` 332 ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"` 333} 334 335type CouponCodeMode string 336 337func (e CouponCodeMode) Ptr() *CouponCodeMode { 338 return &e 339} 340 341const ( 342 COUPONCODEMODE_WECHATPAY CouponCodeMode = "WECHATPAY" 343 COUPONCODEMODE_UPLOAD CouponCodeMode = "UPLOAD" 344 COUPONCODEMODE_API_ASSIGN CouponCodeMode = "API_ASSIGN" 345) 346 347type StockSendRule struct { 348 MaxCount *int64 `json:"max_count,omitempty"` 349 MaxCountPerDay *int64 `json:"max_count_per_day,omitempty"` 350 MaxCountPerUser *int64 `json:"max_count_per_user,omitempty"` 351} 352 353type SingleUsageRule struct { 354 CouponAvailablePeriod *SingleCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 355 NormalCoupon *NormalCouponUsageRule `json:"normal_coupon,omitempty"` 356 DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"` 357 ExchangeCoupon *ExchangeCouponUsageRule `json:"exchange_coupon,omitempty"` 358} 359 360type SequentialUsageRule struct { 361 CouponAvailablePeriod *SequentialCouponAvailablePeriod `json:"coupon_available_period,omitempty"` 362 NormalCouponList []NormalCouponUsageRule `json:"normal_coupon_list,omitempty"` 363 DiscountCouponList []DiscountCouponUsageRule `json:"discount_coupon_list,omitempty"` 364 ExchangeCouponList []ExchangeCouponUsageRule `json:"exchange_coupon_list,omitempty"` 365 SpecialFirst *bool `json:"special_first,omitempty"` 366} 367 368type UsageRuleDisplayInfo struct { 369 CouponUsageMethodList []CouponUsageMethod `json:"coupon_usage_method_list,omitempty"` 370 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 371 MiniProgramPath *string `json:"mini_program_path,omitempty"` 372 AppPath *string `json:"app_path,omitempty"` 373 UsageDescription *string `json:"usage_description,omitempty"` 374 CouponAvailableStoreInfo *CouponAvailableStoreInfo `json:"coupon_available_store_info,omitempty"` 375} 376 377type CouponDisplayInfo struct { 378 CodeDisplayMode *CouponCodeDisplayMode `json:"code_display_mode,omitempty"` 379 BackgroundColor *string `json:"background_color,omitempty"` 380 EntranceMiniProgram *EntranceMiniProgram `json:"entrance_mini_program,omitempty"` 381 EntranceOfficialAccount *EntranceOfficialAccount `json:"entrance_official_account,omitempty"` 382 EntranceFinder *EntranceFinder `json:"entrance_finder,omitempty"` 383} 384 385type NotifyConfig struct { 386 NotifyAppid *string `json:"notify_appid,omitempty"` 387} 388 389type StockStoreScope string 390 391func (e StockStoreScope) Ptr() *StockStoreScope { 392 return &e 393} 394 395const ( 396 STOCKSTORESCOPE_NONE StockStoreScope = "NONE" 397 STOCKSTORESCOPE_ALL StockStoreScope = "ALL" 398 STOCKSTORESCOPE_SPECIFIC StockStoreScope = "SPECIFIC" 399) 400 401type CouponCodeCountInfo struct { 402 TotalCount *int64 `json:"total_count,omitempty"` 403 AvailableCount *int64 `json:"available_count,omitempty"` 404} 405 406type StockSentCountInfo struct { 407 TotalCount *int64 `json:"total_count,omitempty"` 408 TodayCount *int64 `json:"today_count,omitempty"` 409} 410 411type StockState string 412 413func (e StockState) Ptr() *StockState { 414 return &e 415} 416 417const ( 418 STOCKSTATE_AUDITING StockState = "AUDITING" 419 STOCKSTATE_SENDING StockState = "SENDING" 420 STOCKSTATE_PAUSED StockState = "PAUSED" 421 STOCKSTATE_STOPPED StockState = "STOPPED" 422 STOCKSTATE_DEACTIVATED StockState = "DEACTIVATED" 423) 424 425type ComboPackageChoice struct { 426 Name *string `json:"name,omitempty"` 427 Price *int64 `json:"price,omitempty"` 428 Count *int64 `json:"count,omitempty"` 429 ImageUrl *string `json:"image_url,omitempty"` 430 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 431 MiniProgramPath *string `json:"mini_program_path,omitempty"` 432} 433 434type SingleCouponAvailablePeriod struct { 435 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 436 AvailableEndTime *string `json:"available_end_time,omitempty"` 437 AvailableDays *int64 `json:"available_days,omitempty"` 438 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 439 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 440 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 441} 442 443type ExchangeCouponUsageRule struct { 444 Threshold *int64 `json:"threshold,omitempty"` 445 ExchangePrice *int64 `json:"exchange_price,omitempty"` 446} 447 448type SequentialCouponAvailablePeriod struct { 449 AvailableBeginTime *string `json:"available_begin_time,omitempty"` 450 AvailableEndTime *string `json:"available_end_time,omitempty"` 451 WaitDaysAfterReceive *int64 `json:"wait_days_after_receive,omitempty"` 452 WeeklyAvailablePeriod *FixedWeekPeriod `json:"weekly_available_period,omitempty"` 453 IrregularAvailablePeriodList []TimePeriod `json:"irregular_available_period_list,omitempty"` 454} 455 456type CouponUsageMethod string 457 458func (e CouponUsageMethod) Ptr() *CouponUsageMethod { 459 return &e 460} 461 462const ( 463 COUPONUSAGEMETHOD_OFFLINE CouponUsageMethod = "OFFLINE" 464 COUPONUSAGEMETHOD_MINI_PROGRAM CouponUsageMethod = "MINI_PROGRAM" 465 COUPONUSAGEMETHOD_APP CouponUsageMethod = "APP" 466 COUPONUSAGEMETHOD_PAYMENT_CODE CouponUsageMethod = "PAYMENT_CODE" 467) 468 469type CouponAvailableStoreInfo struct { 470 Description *string `json:"description,omitempty"` 471 MiniProgramAppid *string `json:"mini_program_appid,omitempty"` 472 MiniProgramPath *string `json:"mini_program_path,omitempty"` 473} 474 475type CouponCodeDisplayMode string 476 477func (e CouponCodeDisplayMode) Ptr() *CouponCodeDisplayMode { 478 return &e 479} 480 481const ( 482 COUPONCODEDISPLAYMODE_INVISIBLE CouponCodeDisplayMode = "INVISIBLE" 483 COUPONCODEDISPLAYMODE_BARCODE CouponCodeDisplayMode = "BARCODE" 484 COUPONCODEDISPLAYMODE_QRCODE CouponCodeDisplayMode = "QRCODE" 485) 486 487type EntranceMiniProgram struct { 488 Appid *string `json:"appid,omitempty"` 489 Path *string `json:"path,omitempty"` 490 EntranceWording *string `json:"entrance_wording,omitempty"` 491 GuidanceWording *string `json:"guidance_wording,omitempty"` 492} 493 494type EntranceOfficialAccount struct { 495 Appid *string `json:"appid,omitempty"` 496} 497 498type EntranceFinder struct { 499 FinderId *string `json:"finder_id,omitempty"` 500 FinderVideoId *string `json:"finder_video_id,omitempty"` 501 FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"` 502} 503 504type FixedWeekPeriod struct { 505 DayList []WeekEnum `json:"day_list,omitempty"` 506 DayPeriodList []PeriodOfTheDay `json:"day_period_list,omitempty"` 507} 508 509type TimePeriod struct { 510 BeginTime *string `json:"begin_time,omitempty"` 511 EndTime *string `json:"end_time,omitempty"` 512} 513 514type WeekEnum string 515 516func (e WeekEnum) Ptr() *WeekEnum { 517 return &e 518} 519 520const ( 521 WEEKENUM_MONDAY WeekEnum = "MONDAY" 522 WEEKENUM_TUESDAY WeekEnum = "TUESDAY" 523 WEEKENUM_WEDNESDAY WeekEnum = "WEDNESDAY" 524 WEEKENUM_THURSDAY WeekEnum = "THURSDAY" 525 WEEKENUM_FRIDAY WeekEnum = "FRIDAY" 526 WEEKENUM_SATURDAY WeekEnum = "SATURDAY" 527 WEEKENUM_SUNDAY WeekEnum = "SUNDAY" 528) 529 530type PeriodOfTheDay struct { 531 BeginTime *int64 `json:"begin_time,omitempty"` 532 EndTime *int64 `json:"end_time,omitempty"` 533} 534
应答参数
200 OK
product_coupon_id 必填 string(40)
【商品券ID】 商品券的唯一标识,本接口成功时由微信支付生成
scope 必填 string
【优惠范围】 商品券优惠范围
可选取值
ALL: 全场券,此时券类型type仅可配置为NORMAL或DISCOUNTSINGLE: 单品券,此时券类型type配置不受限制,即可配置为NORMAL、DISCOUNT或EXCHANGE
type 必填 string
【商品券类型】 商品券的优惠类型
可选取值
NORMAL: 满减券DISCOUNT: 折扣券EXCHANGE: 兑换券,仅在scope为SINGLE时可配置
usage_mode 必填 string
【使用模式】 商品券使用模式
可选取值
SINGLE: 单券,即用户只能使用一次,使用后券失效SEQUENTIAL: 多次优惠,即用户可以按顺序多次使用,每次核销成功后会发放下一次优惠机会,直到用完为止
single_usage_info 选填 object
【单券模式信息】 单券模式配置信息,仅当 usage_mode 为 SINGLE 时提供,其他场景不提供。
| 属性 | |||||||||
normal_coupon 选填 object 【满减券使用规则】 本商品券内所有批次均以此规则提供满减优惠,当且仅当
discount_coupon 选填 object 【折扣券使用规则】 本商品券内所有批次均以此规则提供折扣优惠,当且仅当
|
sequential_usage_info 选填 object
【多次优惠模式信息】 多次优惠模式配置信息,当且仅当 usage_mode 为 SEQUENTIAL 时提供,其他模式不提供。
| 属性 | |
type 必填 string 【多次优惠规则类型】 多次优惠规则类型 可选取值
count 必填 integer 【可使用次数】 本多次优惠领取后用户可使用次数,最多15次 available_days 必填 integer 【多次优惠有效天数】 用户的多次优惠生效后 N 天内有效,最少3天,最多365天 interval_days 选填 integer 【多次优惠使用间隔天数】 多次优惠多次使用之间需要间隔的天数,最高7天。例如:
默认情况下为 |
display_info 必填 object
【展示信息】 商品券展示信息
| 属性 | |||||||||
name 必填 string(15) 【商品券名称】 商品券名称,长度为3-15个UTF-8字符 image_url 必填 string 【商品券图片】 商品图片的链接地址,仅支持通过图片上传接口获取的图片URL地址。
background_url 必填 string 【商品券背景图】 商品背景图片的URL地址,仅支持通过图片上传接口获取的图片URL地址。
detail_image_url_list 选填 array[string] 【商品券详情图列表】 商品详情图URL地址列表,用于最多可上传8张图片,仅支持通过图片上传接口获取的图片URL地址。
original_price 选填 integer 【商品原价】 单位为分,当且仅当 combo_package_list 选填 array[object] 【套餐组合】 当
|
out_product_no 选填 string
【外部商品ID】 商户创建商品券时主动传入的外部商品ID,原样返回
state 必填 string
【商品券状态】 商品券状态
可选取值
AUDITING: 审批中,审批完成前商品券不可用EFFECTIVE: 生效中,商品券已生效,可以正常使用DEACTIVATED: 已失效,品牌方主动调用失效接口使商品券失效
stock 必填 object
【批次】 商品券批次信息
| 属性 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
product_coupon_id 必填 string(40) 【商品券ID】 商品券的唯一标识,由微信支付生成 stock_id 必填 string(40) 【批次ID】 商品券批次的唯一标识,由微信支付生成 remark 选填 string(20) 【备注】 仅配置品牌可见,用于自定义信息 coupon_code_mode 必填 string 【券Code分配模式】 决定发券时用户商品券Code如何产生 可选取值
coupon_code_count_info 选填 object 【品牌方预上传的券Code数量信息】 当且仅当
stock_send_rule 必填 object 【发放规则】 发放规则
single_usage_rule 选填 object 【单券使用规则】 当且仅当
sequential_usage_rule 选填 object 【多次优惠使用规则】 当且仅当
usage_rule_display_info 必填 object 【券使用规则展示信息】 券使用规则展示信息
coupon_display_info 必填 object 【用户商品券展示信息】 用户商品券在卡包中的展示详情,包括引导用户的自定义入口
notify_config 必填 object 【事件通知配置】 发生券相关事件时,微信支付会向品牌方发送通知,需要提供通知相关配置
store_scope 必填 string 【可用门店范围】 控制该批次可以在品牌下哪些门店使用 可选取值
sent_count_info 必填 object 【已发放次数】 本批次已发放次数
state 必填 string 【批次状态】 商品券批次状态 可选取值
deactivate_request_no 选填 string 【失效请求单号】 当且仅当 deactivate_time 选填 string 【失效时间】 当且仅当 deactivate_reason 选填 string 【失效原因】 当且仅当 |
应答示例
200 OK
创建满100可用的全场8折券
1{ 2 "product_coupon_id" : "1000000013", 3 "scope" : "ALL", 4 "type" : "DISCOUNT", 5 "usage_mode" : "SINGLE", 6 "single_usage_info" : { 7 "discount_coupon" : { 8 "threshold" : 10000, 9 "percent_off" : 20 10 } 11 }, 12 "display_info" : { 13 "name" : "全场满100立打8折", 14 "image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 15 "background_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx", 16 "detail_image_url_list" : [ 17 "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 18 ] 19 }, 20 "state" : "EFFECTIVE", 21 "out_product_no" : "Product_1234567890", 22 "stock" : { 23 "product_coupon_id" : "1000000013", 24 "stock_id" : "1000000013001", 25 "remark" : "8月工作日有效批次", 26 "coupon_code_mode" : "UPLOAD", 27 "coupon_code_count_info" : { 28 "total_count" : 0, 29 "available_count" : 0 30 }, 31 "stock_send_rule" : { 32 "max_count" : 10000000, 33 "max_count_per_user" : 1 34 }, 35 "single_usage_rule" : { 36 "coupon_available_period" : { 37 "available_begin_time" : "2025-08-01T00:00:00+08:00", 38 "available_end_time" : "2025-08-31T23:59:59+08:00", 39 "available_days" : 30, 40 "weekly_available_period" : { 41 "day_list" : [ 42 "MONDAY", 43 "TUESDAY", 44 "WEDNESDAY", 45 "THURSDAY", 46 "FRIDAY" 47 ] 48 } 49 } 50 }, 51 "usage_rule_display_info" : { 52 "coupon_usage_method_list" : [ 53 "OFFLINE", 54 "MINI_PROGRAM", 55 "PAYMENT_CODE" 56 ], 57 "mini_program_appid" : "wx1234567890", 58 "mini_program_path" : "/pages/index/product", 59 "usage_description" : "工作日可用", 60 "coupon_available_store_info" : { 61 "description" : "所有门店可用,可使用小程序查看门店列表", 62 "mini_program_appid" : "wx1234567890", 63 "mini_program_path" : "/pages/index/store-list" 64 } 65 }, 66 "coupon_display_info" : { 67 "code_display_mode" : "QRCODE", 68 "background_color" : "Color010", 69 "entrance_mini_program" : { 70 "appid" : "wx1234567890", 71 "path" : "/pages/index/product", 72 "entrance_wording" : "欢迎选购", 73 "guidance_wording" : "获取更多优惠" 74 }, 75 "entrance_official_account" : { 76 "appid" : "wx1234567890" 77 }, 78 "entrance_finder" : { 79 "finder_id" : "gh_12345678", 80 "finder_video_id" : "UDFsdf24df34dD456Hdf34", 81 "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/wxpaylogo/xxxxx/xxx" 82 } 83 }, 84 "notify_config" : { 85 "notify_appid" : "wx4fd12345678" 86 }, 87 "store_scope" : "NONE", 88 "sent_count_info" : { 89 "total_count" : 0, 90 "today_count" : 0 91 }, 92 "state" : "SENDING" 93 } 94} 95
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示
状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
400 | INVALID_REQUEST | 商品券使用模式(usage_mode)非法,不可以使此模式 | 请使用其他 usage_mode |
400 | INVALID_REQUEST | usage_mode 为 SINGLE 时,批次未填写 single_usage_rule | 请填写 single_usage_rule |
400 | INVALID_REQUEST | usage_mode 为 SEQUENTIAL 时,批次未填写 sequential_usage_rule | 请填写 sequential_usage_rule |
400 | INVALID_REQUEST | 单券使用模式的商品券批次,应该在「单券使用规则」中包含对应类型的优惠规则。对于文档中标记不应填写的优惠规则应删除。 | 请在「单券使用规则」中包含对应类型的优惠规则,并删除文档中标记不应填写的优惠规则。 |
400 | INVALID_REQUEST | 多次优惠使用模式的商品券批次,应该在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 | 在「多次优惠使用规则」中包含对应类型的优惠规则,且数量与多次优惠的优惠次数相等 |
400 | INVALID_REQUEST | 单品满减券或单品折扣券不应在商品券中设置「满减券使用规则」或「折扣券使用规则」,而是应该在商品券批次中设置 | 请删除商品券中的「满减券使用规则」或「折扣券使用规则」,并在商品券批次中设置对应的优惠规则 |
403 | NO_AUTH | 品牌没有此接口权限 | 品牌没有此接口权限 |
400 | INVALID_REQUEST | 全场券的券类型只能设置为 「满减券」和「折扣券」,不可以设置为「换购券」 | 请更换券类型为「满减券」或「折扣券」;或者更换券使用范围为「单品券』 |
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 |


