查询商品券

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

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("200000001"),
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	SequentialUsageInfo *SequentialUsageInfo      `json:"sequential_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_SEQUENTIAL UsageMode = "SEQUENTIAL"
174)
175
176type SingleUsageInfo struct {
177	NormalCoupon   *NormalCouponUsageRule   `json:"normal_coupon,omitempty"`
178	DiscountCoupon *DiscountCouponUsageRule `json:"discount_coupon,omitempty"`
179}
180
181type SequentialUsageInfo struct {
182	Type          *SequentialUsageType `json:"type,omitempty"`
183	Count         *int64               `json:"count,omitempty"`
184	AvailableDays *int64               `json:"available_days,omitempty"`
185	IntervalDays  *int64               `json:"interval_days,omitempty"`
186}
187
188type ProductCouponDisplayInfo struct {
189	Name               *string        `json:"name,omitempty"`
190	ImageUrl           *string        `json:"image_url,omitempty"`
191	BackgroundUrl      *string        `json:"background_url,omitempty"`
192	DetailImageUrlList []string       `json:"detail_image_url_list,omitempty"`
193	OriginalPrice      *int64         `json:"original_price,omitempty"`
194	ComboPackageList   []ComboPackage `json:"combo_package_list,omitempty"`
195}
196
197type ProductCouponState string
198
199func (e ProductCouponState) Ptr() *ProductCouponState {
200	return &e
201}
202
203const (
204	PRODUCTCOUPONSTATE_AUDITING    ProductCouponState = "AUDITING"
205	PRODUCTCOUPONSTATE_EFFECTIVE   ProductCouponState = "EFFECTIVE"
206	PRODUCTCOUPONSTATE_DEACTIVATED ProductCouponState = "DEACTIVATED"
207)
208
209type NormalCouponUsageRule struct {
210	Threshold      *int64 `json:"threshold,omitempty"`
211	DiscountAmount *int64 `json:"discount_amount,omitempty"`
212}
213
214type DiscountCouponUsageRule struct {
215	Threshold  *int64 `json:"threshold,omitempty"`
216	PercentOff *int64 `json:"percent_off,omitempty"`
217}
218
219type SequentialUsageType string
220
221func (e SequentialUsageType) Ptr() *SequentialUsageType {
222	return &e
223}
224
225const (
226	SEQUENTIALUSAGETYPE_INCREMENTAL SequentialUsageType = "INCREMENTAL"
227	SEQUENTIALUSAGETYPE_EQUAL       SequentialUsageType = "EQUAL"
228)
229
230type ComboPackage struct {
231	Name       *string              `json:"name,omitempty"`
232	PickCount  *int64               `json:"pick_count,omitempty"`
233	ChoiceList []ComboPackageChoice `json:"choice_list,omitempty"`
234}
235
236type ComboPackageChoice struct {
237	Name             *string `json:"name,omitempty"`
238	Price            *int64  `json:"price,omitempty"`
239	Count            *int64  `json:"count,omitempty"`
240	ImageUrl         *string `json:"image_url,omitempty"`
241	MiniProgramAppid *string `json:"mini_program_appid,omitempty"`
242	MiniProgramPath  *string `json:"mini_program_path,omitempty"`
243}
244