查询商品券

1curl -X GET \
2  https://api.mch.weixin.qq.com/v3/marketing/partner/product-coupon/product-coupons/1000000013?brand_id=120344 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" 
5

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

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