查询商品券

1curl -X GET \
2  https://api.mch.weixin.qq.com/brand/marketing/product-coupon/product-coupons/200000001 \
3  -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \
4  -H "Accept: application/json" \
5  -H "Wechatpay-Serial: PUB_KEY_ID_XXXX"  
6

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 GetProductCoupon {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "GET";
28  private static String PATH = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
32    GetProductCoupon client = new GetProductCoupon(
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    GetProductCouponRequest request = new GetProductCouponRequest();
41    request.productCouponId = "200000001";
42    try {
43      ProductCouponEntity response = client.run(request);
44        // TODO: 请求成功，继续业务逻辑
45        System.out.println(response);
46    } catch (WXPayBrandUtility.ApiException e) {
47        // TODO: 请求失败，根据状态码执行不同的逻辑
48        e.printStackTrace();
49    }
50  }
51
52  public ProductCouponEntity run(GetProductCouponRequest request) {
53    String uri = PATH;
54    uri = uri.replace("{product_coupon_id}", WXPayBrandUtility.urlEncode(request.productCouponId));
55
56    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
57    reqBuilder.addHeader("Accept", "application/json");
58    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
59    reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo, privateKey, METHOD, uri, null));
60    reqBuilder.method(METHOD, null);
61    Request httpRequest = reqBuilder.build();
62
63    // 发送HTTP请求
64    OkHttpClient client = new OkHttpClient.Builder().build();
65    try (Response httpResponse = client.newCall(httpRequest).execute()) {
66      String respBody = WXPayBrandUtility.extractBody(httpResponse);
67      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
68        // 2XX 成功，验证应答签名
69        WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
70            httpResponse.headers(), respBody);
71
72        // 从HTTP应答报文构建返回数据
73        return WXPayBrandUtility.fromJson(respBody, ProductCouponEntity.class);
74      } else {
75        throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
76      }
77    } catch (IOException e) {
78      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
79    }
80  }
81
82  private final String brand_id;
83  private final String certificateSerialNo;
84  private final PrivateKey privateKey;
85  private final String wechatPayPublicKeyId;
86  private final PublicKey wechatPayPublicKey;
87
88  public GetProductCoupon(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
89    this.brand_id = brand_id;
90    this.certificateSerialNo = certificateSerialNo;
91    this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath);
92    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
93    this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
94  }
95
96  public static class GetProductCouponRequest {
97    @SerializedName("product_coupon_id")
98    @Expose(serialize = false)
99    public String productCouponId;
100  }
101  
102  public static class ProductCouponEntity {
103    @SerializedName("product_coupon_id")
104    public String productCouponId;
105  
106    @SerializedName("scope")
107    public ProductCouponScope scope;
108  
109    @SerializedName("type")
110    public ProductCouponType type;
111  
112    @SerializedName("usage_mode")
113    public UsageMode usageMode;
114  
115    @SerializedName("single_usage_info")
116    public SingleUsageInfo singleUsageInfo;
117  
118    @SerializedName("sequential_usage_info")
119    public SequentialUsageInfo sequentialUsageInfo;
120  
121    @SerializedName("display_info")
122    public ProductCouponDisplayInfo displayInfo;
123  
124    @SerializedName("out_product_no")
125    public String outProductNo;
126  
127    @SerializedName("state")
128    public ProductCouponState state;
129  
130    @SerializedName("deactivate_request_no")
131    public String deactivateRequestNo;
132  
133    @SerializedName("deactivate_time")
134    public String deactivateTime;
135  
136    @SerializedName("deactivate_reason")
137    public String deactivateReason;
138  }
139  
140  public enum ProductCouponScope {
141    @SerializedName("ALL")
142    ALL,
143    @SerializedName("SINGLE")
144    SINGLE
145  }
146  
147  public enum ProductCouponType {
148    @SerializedName("NORMAL")
149    NORMAL,
150    @SerializedName("DISCOUNT")
151    DISCOUNT,
152    @SerializedName("EXCHANGE")
153    EXCHANGE
154  }
155  
156  public enum UsageMode {
157    @SerializedName("SINGLE")
158    SINGLE,
159    @SerializedName("SEQUENTIAL")
160    SEQUENTIAL
161  }
162  
163  public static class SingleUsageInfo {
164    @SerializedName("normal_coupon")
165    public NormalCouponUsageRule normalCoupon;
166  
167    @SerializedName("discount_coupon")
168    public DiscountCouponUsageRule discountCoupon;
169  }
170  
171  public static class SequentialUsageInfo {
172    @SerializedName("type")
173    public SequentialUsageType type;
174  
175    @SerializedName("count")
176    public Long count;
177  
178    @SerializedName("available_days")
179    public Long availableDays;
180  
181    @SerializedName("interval_days")
182    public Long intervalDays;
183  }
184  
185  public static class ProductCouponDisplayInfo {
186    @SerializedName("name")
187    public String name;
188  
189    @SerializedName("image_url")
190    public String imageUrl;
191  
192    @SerializedName("background_url")
193    public String backgroundUrl;
194  
195    @SerializedName("detail_image_url_list")
196    public List<String> detailImageUrlList;
197  
198    @SerializedName("original_price")
199    public Long originalPrice;
200  
201    @SerializedName("combo_package_list")
202    public List<ComboPackage> comboPackageList;
203  }
204  
205  public enum ProductCouponState {
206    @SerializedName("AUDITING")
207    AUDITING,
208    @SerializedName("EFFECTIVE")
209    EFFECTIVE,
210    @SerializedName("DEACTIVATED")
211    DEACTIVATED
212  }
213  
214  public static class NormalCouponUsageRule {
215    @SerializedName("threshold")
216    public Long threshold;
217  
218    @SerializedName("discount_amount")
219    public Long discountAmount;
220  }
221  
222  public static class DiscountCouponUsageRule {
223    @SerializedName("threshold")
224    public Long threshold;
225  
226    @SerializedName("percent_off")
227    public Long percentOff;
228  }
229  
230  public enum SequentialUsageType {
231    @SerializedName("INCREMENTAL")
232    INCREMENTAL,
233    @SerializedName("EQUAL")
234    EQUAL
235  }
236  
237  public static class ComboPackage {
238    @SerializedName("name")
239    public String name;
240  
241    @SerializedName("pick_count")
242    public Long pickCount;
243  
244    @SerializedName("choice_list")
245    public List<ComboPackageChoice> choiceList = new ArrayList<ComboPackageChoice>();
246  }
247  
248  public static class ComboPackageChoice {
249    @SerializedName("name")
250    public String name;
251  
252    @SerializedName("price")
253    public Long price;
254  
255    @SerializedName("count")
256    public Long count;
257  
258    @SerializedName("image_url")
259    public String imageUrl;
260  
261    @SerializedName("mini_program_appid")
262    public String miniProgramAppid;
263  
264    @SerializedName("mini_program_path")
265    public String miniProgramPath;
266  }
267  
268}
269

1package main
2
3import (
4	"demo/wxpay_brand_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/brand/4015826866
5	"encoding/json"
6	"fmt"
7	"net/http"
8	"net/url"
9	"strings"
10)
11
12func main() {
13	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/brand/4015415289
14	config, err := wxpay_brand_utility.CreateBrandConfig(
15		"xxxxxxxx",                   // 品牌ID，是由微信支付系统生成并分配给每个品牌方的唯一标识符，品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289
16		"1DDE55AD98Exxxxxxxxxx",      // 品牌API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570
17		"/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径，本地文件路径
18		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439
19		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
20	)
21	if err != nil {
22		fmt.Println(err)
23		return
24	}
25
26	request := &GetProductCouponRequest{
27		ProductCouponId: wxpay_brand_utility.String("200000001"),
28	}
29
30	response, err := GetProductCoupon(config, request)
31	if err != nil {
32		fmt.Printf("请求失败: %+v\n", err)
33		// TODO: 请求失败，根据状态码执行不同的处理
34		return
35	}
36
37	// TODO: 请求成功，继续业务逻辑
38	fmt.Printf("请求成功: %+v\n", response)
39}
40
41func GetProductCoupon(config *wxpay_brand_utility.BrandConfig, request *GetProductCouponRequest) (response *ProductCouponEntity, err error) {
42	const (
43		host   = "https://api.mch.weixin.qq.com"
44		method = "GET"
45		path   = "/brand/marketing/product-coupon/product-coupons/{product_coupon_id}"
46	)
47
48	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
49	if err != nil {
50		return nil, err
51	}
52	reqUrl.Path = strings.Replace(reqUrl.Path, "{product_coupon_id}", url.PathEscape(*request.ProductCouponId), -1)
53	httpRequest, err := http.NewRequest(method, reqUrl.String(), nil)
54	if err != nil {
55		return nil, err
56	}
57	httpRequest.Header.Set("Accept", "application/json")
58	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
59	authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), nil)
60	if err != nil {
61		return nil, err
62	}
63	httpRequest.Header.Set("Authorization", authorization)
64
65	client := &http.Client{}
66	httpResponse, err := client.Do(httpRequest)
67	if err != nil {
68		return nil, err
69	}
70	respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse)
71	if err != nil {
72		return nil, err
73	}
74	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
75		// 2XX 成功，验证应答签名
76		err = wxpay_brand_utility.ValidateResponse(
77			config.WechatPayPublicKeyId(),
78			config.WechatPayPublicKey(),
79			&httpResponse.Header,
80			respBody,
81		)
82		if err != nil {
83			return nil, err
84		}
85		response := &ProductCouponEntity{}
86		if err := json.Unmarshal(respBody, response); err != nil {
87			return nil, err
88		}
89
90		return response, nil
91	} else {
92		return nil, wxpay_brand_utility.NewApiException(
93			httpResponse.StatusCode,
94			httpResponse.Header,
95			respBody,
96		)
97	}
98}
99
100type GetProductCouponRequest struct {
101	ProductCouponId *string `json:"product_coupon_id,omitempty"`
102}
103
104func (o *GetProductCouponRequest) MarshalJSON() ([]byte, error) {
105	type Alias GetProductCouponRequest
106	a := &struct {
107		ProductCouponId *string `json:"product_coupon_id,omitempty"`
108		*Alias
109	}{
110		// 序列化时移除非 Body 字段
111		ProductCouponId: nil,
112		Alias:           (*Alias)(o),
113	}
114	return json.Marshal(a)
115}
116
117type ProductCouponEntity struct {
118	ProductCouponId     *string                   `json:"product_coupon_id,omitempty"`
119	Scope               *ProductCouponScope       `json:"scope,omitempty"`
120	Type                *ProductCouponType        `json:"type,omitempty"`
121	UsageMode           *UsageMode                `json:"usage_mode,omitempty"`
122	SingleUsageInfo     *SingleUsageInfo          `json:"single_usage_info,omitempty"`
123	SequentialUsageInfo *SequentialUsageInfo      `json:"sequential_usage_info,omitempty"`
124	DisplayInfo         *ProductCouponDisplayInfo `json:"display_info,omitempty"`
125	OutProductNo        *string                   `json:"out_product_no,omitempty"`
126	State               *ProductCouponState       `json:"state,omitempty"`
127	DeactivateRequestNo *string                   `json:"deactivate_request_no,omitempty"`
128	DeactivateTime      *string                   `json:"deactivate_time,omitempty"`
129	DeactivateReason    *string                   `json:"deactivate_reason,omitempty"`
130}
131
132type ProductCouponScope string
133
134func (e ProductCouponScope) Ptr() *ProductCouponScope {
135	return &e
136}
137
138const (
139	PRODUCTCOUPONSCOPE_ALL    ProductCouponScope = "ALL"
140	PRODUCTCOUPONSCOPE_SINGLE ProductCouponScope = "SINGLE"
141)
142
143type ProductCouponType string
144
145func (e ProductCouponType) Ptr() *ProductCouponType {
146	return &e
147}
148
149const (
150	PRODUCTCOUPONTYPE_NORMAL   ProductCouponType = "NORMAL"
151	PRODUCTCOUPONTYPE_DISCOUNT ProductCouponType = "DISCOUNT"
152	PRODUCTCOUPONTYPE_EXCHANGE ProductCouponType = "EXCHANGE"
153)
154
155type UsageMode string
156
157func (e UsageMode) Ptr() *UsageMode {
158	return &e
159}
160
161const (
162	USAGEMODE_SINGLE     UsageMode = "SINGLE"
163	USAGEMODE_SEQUENTIAL UsageMode = "SEQUENTIAL"
164)
165
166type SingleUsageInfo struct {
167	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
168	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
169}
170
171type SequentialUsageInfo struct {
172	Type          *SequentialUsageType `json:"type,omitempty"`
173	Count         *int64               `json:"count,omitempty"`
174	AvailableDays *int64               `json:"available_days,omitempty"`
175	IntervalDays  *int64               `json:"interval_days,omitempty"`
176}
177
178type ProductCouponDisplayInfo struct {
179	Name               *string        `json:"name,omitempty"`
180	ImageUrl           *string        `json:"image_url,omitempty"`
181	BackgroundUrl      *string        `json:"background_url,omitempty"`
182	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
183	OriginalPrice      *int64         `json:"original_price,omitempty"`
184	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
185}
186
187type ProductCouponState string
188
189func (e ProductCouponState) Ptr() *ProductCouponState {
190	return &e
191}
192
193const (
194	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
195	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
196	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
197)
198
199type NormalCouponUsageRule struct {
200	Threshold      *int64 `json:"threshold,omitempty"`
201	DiscountAmount *int64 `json:"discount_amount,omitempty"`
202}
203
204type DiscountCouponUsageRule struct {
205	Threshold  *int64 `json:"threshold,omitempty"`
206	PercentOff *int64 `json:"percent_off,omitempty"`
207}
208
209type SequentialUsageType string
210
211func (e SequentialUsageType) Ptr() *SequentialUsageType {
212	return &e
213}
214
215const (
216	SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL"
217	SEQUENTIALUSAGETYPE_EQUAL       SequentialUsageType = "EQUAL"
218)
219
220type ComboPackage struct {
221	Name       *string              `json:"name,omitempty"`
222	PickCount  *int64               `json:"pick_count,omitempty"`
223	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
224}
225
226type ComboPackageChoice struct {
227	Name             *string `json:"name,omitempty"`
228	Price            *int64  `json:"price,omitempty"`
229	Count            *int64  `json:"count,omitempty"`
230	ImageUrl         *string `json:"image_url,omitempty"`
231	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
232	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
233}
234