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

