修改商家券基本信息

1curl -X PATCH \
2  https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/101156451224 \
3  -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \
4  -H "Accept: application/json" \
5  -H "Content-Type: application/json" \
6  -d '{
7    "custom_entrance" : {
8      "mini_programs_info" : {
9        "mini_programs_appid" : "wx234545656765876",
10        "mini_programs_path" : "/path/index/index",
11        "entrance_words" : "欢迎选购",
12        "guiding_words" : "获取更多优惠"
13      },
14      "appid" : "wx324345hgfhfghfg",
15      "hall_id" : "233455656",
16      "code_display_mode" : "BARCODE"
17    },
18    "stock_name" : "8月1日活动券",
19    "comment" : "活动使用",
20    "goods_name" : "xxx商品使用",
21    "out_request_no" : "6122352020010133287985742",
22    "display_pattern_info" : {
23      "description" : "xxx门店可用",
24      "merchant_logo_url" : "https://xxx",
25      "merchant_name" : "微信支付",
26      "background_color" : "xxxxx",
27      "coupon_image_url" : "图片cdn地址",
28      "finder_info" : {
29        "finder_id" : "sph6Rngt2T4RlUf",
30        "finder_video_id" : "export/UzFfAgtgekIEAQAAAAAAb4MgnPInmAAAAAstQy6ubaLX4KHWvLEZgBPEwIEgVnk9HIP-zNPgMJofG6tpdGPJNg_ojtEjoT94",
31        "finder_video_cover_image_url" : "https://wxpaylogo.qpic.cn/xxx"
32      }
33    },
34    "coupon_use_rule" : {
35      "use_method" : "OFF_LINE",
36      "mini_programs_appid" : "wx23232232323",
37      "mini_programs_path" : "/path/index/index"
38    },
39    "stock_send_rule" : {
40      "natural_person_limit" : false,
41      "prevent_api_abuse" : false
42    },
43    "notify_config" : {
44      "notify_appid" : "wx23232232323"
45    },
46    "subsidy" : true
47  }'
48

1package com.java.demo;
2
3import com.java.utils.WXPayUtility; // 引用微信支付工具库，参考：https://pay.weixin.qq.com/doc/v3/merchant/4014931831
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 ModifyStockInfo {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "PATCH";
28  private static String PATH = "/v3/marketing/busifavor/stocks/{stock_id}";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
32    ModifyStockInfo client = new ModifyStockInfo(
33      "19xxxxxxxx",                    // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
34      "1DDE55AD98Exxxxxxxxxx",         // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
35      "/path/to/apiclient_key.pem",     // 商户API证书私钥文件路径，本地文件路径
36      "PUB_KEY_ID_xxxxxxxxxxxxx",      // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
37      "/path/to/wxp_pub.pem"           // 微信支付公钥文件路径，本地文件路径
38    );
39
40    ModifyStockInfoRequest request = new ModifyStockInfoRequest();
41    request.stockId = "101156451224";
42    request.customEntrance = new ModifyCustomEntrance();
43    request.customEntrance.miniProgramsInfo = new ModifyMiniAppInfo();
44    request.customEntrance.miniProgramsInfo.miniProgramsAppid = "wx234545656765876";
45    request.customEntrance.miniProgramsInfo.miniProgramsPath = "/path/index/index";
46    request.customEntrance.miniProgramsInfo.entranceWords = "欢迎选购";
47    request.customEntrance.miniProgramsInfo.guidingWords = "获取更多优惠";
48    request.customEntrance.appid = "wx324345hgfhfghfg";
49    request.customEntrance.hallId = "233455656";
50    request.customEntrance.codeDisplayMode = CodeDisplayMode.BARCODE;
51    request.stockName = "8月1日活动券";
52    request.comment = "活动使用";
53    request.goodsName = "xxx商品使用";
54    request.outRequestNo = "6122352020010133287985742";
55    request.displayPatternInfo = new DisplayPatternInfo();
56    request.displayPatternInfo.description = "xxx门店可用";
57    request.displayPatternInfo.merchantLogoUrl = "https://xxx";
58    request.displayPatternInfo.merchantName = "微信支付";
59    request.displayPatternInfo.backgroundColor = "xxxxx";
60    request.displayPatternInfo.couponImageUrl = "图片cdn地址";
61    request.displayPatternInfo.finderInfo = new FinderInfo();
62    request.displayPatternInfo.finderInfo.finderId = "sph6Rngt2T4RlUf";
63    request.displayPatternInfo.finderInfo.finderVideoId = "export/UzFfAgtgekIEAQAAAAAAb4MgnPInmAAAAAstQy6ubaLX4KHWvLEZgBPEwIEgVnk9HIP-zNPgMJofG6tpdGPJNg_ojtEjoT94";
64    request.displayPatternInfo.finderInfo.finderVideoCoverImageUrl = "https://wxpaylogo.qpic.cn/xxx";
65    request.couponUseRule = new ModifyCouponUseRule();
66    request.couponUseRule.useMethod = CouponUseMethod.OFF_LINE;
67    request.couponUseRule.miniProgramsAppid = "wx23232232323";
68    request.couponUseRule.miniProgramsPath = "/path/index/index";
69    request.stockSendRule = new ModifyStockSendRule();
70    request.stockSendRule.naturalPersonLimit = false;
71    request.stockSendRule.preventApiAbuse = false;
72    request.notifyConfig = new NotifyConfig();
73    request.notifyConfig.notifyAppid = "wx23232232323";
74    request.subsidy = true;
75    try {
76      client.run(request);
77    } catch (WXPayUtility.ApiException e) {
78        // TODO: 请求失败，根据状态码执行不同的逻辑
79        e.printStackTrace();
80    }
81  }
82
83  public void run(ModifyStockInfoRequest request) {
84    String uri = PATH;
85    uri = uri.replace("{stock_id}", WXPayUtility.urlEncode(request.stockId));
86    String reqBody = WXPayUtility.toJson(request);
87
88    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
89    reqBuilder.addHeader("Accept", "application/json");
90    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
91    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
92    reqBuilder.addHeader("Content-Type", "application/json");
93    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
94    reqBuilder.method(METHOD, requestBody);
95    Request httpRequest = reqBuilder.build();
96
97    // 发送HTTP请求
98    OkHttpClient client = new OkHttpClient.Builder().build();
99    try (Response httpResponse = client.newCall(httpRequest).execute()) {
100      String respBody = WXPayUtility.extractBody(httpResponse);
101      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
102        // 2XX 成功，验证应答签名
103        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
104            httpResponse.headers(), respBody);
105
106        return;
107      } else {
108        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
109      }
110    } catch (IOException e) {
111      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
112    }
113  }
114
115  private final String mchid;
116  private final String certificateSerialNo;
117  private final PrivateKey privateKey;
118  private final String wechatPayPublicKeyId;
119  private final PublicKey wechatPayPublicKey;
120
121  public ModifyStockInfo(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
122    this.mchid = mchid;
123    this.certificateSerialNo = certificateSerialNo;
124    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
125    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
126    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
127  }
128
129  public static class ModifyStockInfoRequest {
130    @SerializedName("stock_id")
131    @Expose(serialize = false)
132    public String stockId;
133  
134    @SerializedName("custom_entrance")
135    public ModifyCustomEntrance customEntrance;
136  
137    @SerializedName("stock_name")
138    public String stockName;
139  
140    @SerializedName("comment")
141    public String comment;
142  
143    @SerializedName("goods_name")
144    public String goodsName;
145  
146    @SerializedName("out_request_no")
147    public String outRequestNo;
148  
149    @SerializedName("display_pattern_info")
150    public DisplayPatternInfo displayPatternInfo;
151  
152    @SerializedName("coupon_use_rule")
153    public ModifyCouponUseRule couponUseRule;
154  
155    @SerializedName("stock_send_rule")
156    public ModifyStockSendRule stockSendRule;
157  
158    @SerializedName("notify_config")
159    public NotifyConfig notifyConfig;
160  
161    @SerializedName("subsidy")
162    public Boolean subsidy;
163  }
164  
165  public static class ModifyCustomEntrance {
166    @SerializedName("mini_programs_info")
167    public ModifyMiniAppInfo miniProgramsInfo;
168  
169    @SerializedName("appid")
170    public String appid;
171  
172    @SerializedName("hall_id")
173    public String hallId;
174  
175    @SerializedName("code_display_mode")
176    public CodeDisplayMode codeDisplayMode;
177  }
178  
179  public static class DisplayPatternInfo {
180    @SerializedName("description")
181    public String description;
182  
183    @SerializedName("merchant_logo_url")
184    public String merchantLogoUrl;
185  
186    @SerializedName("merchant_name")
187    public String merchantName;
188  
189    @SerializedName("background_color")
190    public String backgroundColor;
191  
192    @SerializedName("coupon_image_url")
193    public String couponImageUrl;
194  
195    @SerializedName("finder_info")
196    public FinderInfo finderInfo;
197  }
198  
199  public static class ModifyCouponUseRule {
200    @SerializedName("use_method")
201    public CouponUseMethod useMethod;
202  
203    @SerializedName("mini_programs_appid")
204    public String miniProgramsAppid;
205  
206    @SerializedName("mini_programs_path")
207    public String miniProgramsPath;
208  }
209  
210  public static class ModifyStockSendRule {
211    @SerializedName("natural_person_limit")
212    public Boolean naturalPersonLimit;
213  
214    @SerializedName("prevent_api_abuse")
215    public Boolean preventApiAbuse;
216  }
217  
218  public static class NotifyConfig {
219    @SerializedName("notify_appid")
220    public String notifyAppid;
221  }
222  
223  public static class ModifyMiniAppInfo {
224    @SerializedName("mini_programs_appid")
225    public String miniProgramsAppid;
226  
227    @SerializedName("mini_programs_path")
228    public String miniProgramsPath;
229  
230    @SerializedName("entrance_words")
231    public String entranceWords;
232  
233    @SerializedName("guiding_words")
234    public String guidingWords;
235  }
236  
237  public enum CodeDisplayMode {
238    @SerializedName("NOT_SHOW")
239    NOT_SHOW,
240    @SerializedName("BARCODE")
241    BARCODE,
242    @SerializedName("QRCODE")
243    QRCODE
244  }
245  
246  public static class FinderInfo {
247    @SerializedName("finder_id")
248    public String finderId;
249  
250    @SerializedName("finder_video_id")
251    public String finderVideoId;
252  
253    @SerializedName("finder_video_cover_image_url")
254    public String finderVideoCoverImageUrl;
255  }
256  
257  public enum CouponUseMethod {
258    @SerializedName("OFF_LINE")
259    OFF_LINE,
260    @SerializedName("MINI_PROGRAMS")
261    MINI_PROGRAMS,
262    @SerializedName("SELF_CONSUME")
263    SELF_CONSUME,
264    @SerializedName("PAYMENT_CODE")
265    PAYMENT_CODE
266  }
267  
268}
269

1package main
2
3import (
4	"bytes"
5	"demo/wxpay_utility" // 引用微信支付工具库，参考 https://pay.weixin.qq.com/doc/v3/merchant/4015119334
6	"encoding/json"
7	"fmt"
8	"net/http"
9	"net/url"
10	"strings"
11)
12
13func main() {
14	// TODO: 请准备商户开发必要参数，参考：https://pay.weixin.qq.com/doc/v3/merchant/4013070756
15	config, err := wxpay_utility.CreateMchConfig(
16		"19xxxxxxxx",                 // 商户号，是由微信支付系统生成并分配给每个商户的唯一标识符，商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/merchant/4013070756
17		"1DDE55AD98Exxxxxxxxxx",      // 商户API证书序列号，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013053053
18		"/path/to/apiclient_key.pem", // 商户API证书私钥文件路径，本地文件路径
19		"PUB_KEY_ID_xxxxxxxxxxxxx",   // 微信支付公钥ID，如何获取请参考 https://pay.weixin.qq.com/doc/v3/merchant/4013038816
20		"/path/to/wxp_pub.pem",       // 微信支付公钥文件路径，本地文件路径
21	)
22	if err != nil {
23		fmt.Println(err)
24		return
25	}
26
27	request := &ModifyStockInfoRequest{
28		StockId: wxpay_utility.String("101156451224"),
29		CustomEntrance: &ModifyCustomEntrance{
30			MiniProgramsInfo: &ModifyMiniAppInfo{
31				MiniProgramsAppid: wxpay_utility.String("wx234545656765876"),
32				MiniProgramsPath:  wxpay_utility.String("/path/index/index"),
33				EntranceWords:     wxpay_utility.String("欢迎选购"),
34				GuidingWords:      wxpay_utility.String("获取更多优惠"),
35			},
36			Appid:           wxpay_utility.String("wx324345hgfhfghfg"),
37			HallId:          wxpay_utility.String("233455656"),
38			CodeDisplayMode: CODEDISPLAYMODE_BARCODE.Ptr(),
39		},
40		StockName:    wxpay_utility.String("8月1日活动券"),
41		Comment:      wxpay_utility.String("活动使用"),
42		GoodsName:    wxpay_utility.String("xxx商品使用"),
43		OutRequestNo: wxpay_utility.String("6122352020010133287985742"),
44		DisplayPatternInfo: &DisplayPatternInfo{
45			Description:     wxpay_utility.String("xxx门店可用"),
46			MerchantLogoUrl: wxpay_utility.String("https://xxx"),
47			MerchantName:    wxpay_utility.String("微信支付"),
48			BackgroundColor: wxpay_utility.String("xxxxx"),
49			CouponImageUrl:  wxpay_utility.String("图片cdn地址"),
50			FinderInfo: &FinderInfo{
51				FinderId:                 wxpay_utility.String("sph6Rngt2T4RlUf"),
52				FinderVideoId:            wxpay_utility.String("export/UzFfAgtgekIEAQAAAAAAb4MgnPInmAAAAAstQy6ubaLX4KHWvLEZgBPEwIEgVnk9HIP-zNPgMJofG6tpdGPJNg_ojtEjoT94"),
53				FinderVideoCoverImageUrl: wxpay_utility.String("https://wxpaylogo.qpic.cn/xxx"),
54			},
55		},
56		CouponUseRule: &ModifyCouponUseRule{
57			UseMethod:         COUPONUSEMETHOD_OFF_LINE.Ptr(),
58			MiniProgramsAppid: wxpay_utility.String("wx23232232323"),
59			MiniProgramsPath:  wxpay_utility.String("/path/index/index"),
60		},
61		StockSendRule: &ModifyStockSendRule{
62			NaturalPersonLimit: wxpay_utility.Bool(false),
63			PreventApiAbuse:    wxpay_utility.Bool(false),
64		},
65		NotifyConfig: &NotifyConfig{
66			NotifyAppid: wxpay_utility.String("wx23232232323"),
67		},
68		Subsidy: wxpay_utility.Bool(true),
69	}
70
71	err = ModifyStockInfo(config, request)
72	if err != nil {
73		fmt.Printf("请求失败: %+v\n", err)
74		// TODO: 请求失败，根据状态码执行不同的处理
75		return
76	}
77
78	// TODO: 请求成功，继续业务逻辑
79	fmt.Println("请求成功")
80}
81
82func ModifyStockInfo(config *wxpay_utility.MchConfig, request *ModifyStockInfoRequest) (err error) {
83	const (
84		host   = "https://api.mch.weixin.qq.com"
85		method = "PATCH"
86		path   = "/v3/marketing/busifavor/stocks/{stock_id}"
87	)
88
89	reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path))
90	if err != nil {
91		return err
92	}
93	reqUrl.Path = strings.Replace(reqUrl.Path, "{stock_id}", url.PathEscape(*request.StockId), -1)
94	reqBody, err := json.Marshal(request)
95	if err != nil {
96		return err
97	}
98	httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody))
99	if err != nil {
100		return err
101	}
102	httpRequest.Header.Set("Accept", "application/json")
103	httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId())
104	httpRequest.Header.Set("Content-Type", "application/json")
105	authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody)
106	if err != nil {
107		return err
108	}
109	httpRequest.Header.Set("Authorization", authorization)
110
111	client := &http.Client{}
112	httpResponse, err := client.Do(httpRequest)
113	if err != nil {
114		return err
115	}
116	respBody, err := wxpay_utility.ExtractResponseBody(httpResponse)
117	if err != nil {
118		return err
119	}
120	if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 {
121		// 2XX 成功，验证应答签名
122		err = wxpay_utility.ValidateResponse(
123			config.WechatPayPublicKeyId(),
124			config.WechatPayPublicKey(),
125			&httpResponse.Header,
126			respBody,
127		)
128		if err != nil {
129			return err
130		}
131		return nil
132	} else {
133		return wxpay_utility.NewApiException(
134			httpResponse.StatusCode,
135			httpResponse.Header,
136			respBody,
137		)
138	}
139}
140
141type ModifyStockInfoRequest struct {
142	StockId            *string               `json:"stock_id,omitempty"`
143	CustomEntrance     *ModifyCustomEntrance `json:"custom_entrance,omitempty"`
144	StockName          *string               `json:"stock_name,omitempty"`
145	Comment            *string               `json:"comment,omitempty"`
146	GoodsName          *string               `json:"goods_name,omitempty"`
147	OutRequestNo       *string               `json:"out_request_no,omitempty"`
148	DisplayPatternInfo *DisplayPatternInfo   `json:"display_pattern_info,omitempty"`
149	CouponUseRule      *ModifyCouponUseRule  `json:"coupon_use_rule,omitempty"`
150	StockSendRule      *ModifyStockSendRule  `json:"stock_send_rule,omitempty"`
151	NotifyConfig       *NotifyConfig         `json:"notify_config,omitempty"`
152	Subsidy            *bool                 `json:"subsidy,omitempty"`
153}
154
155func (o *ModifyStockInfoRequest) MarshalJSON() ([]byte, error) {
156	type Alias ModifyStockInfoRequest
157	a := &struct {
158		StockId *string `json:"stock_id,omitempty"`
159		*Alias
160	}{
161		// 序列化时移除非 Body 字段
162		StockId: nil,
163		Alias:   (*Alias)(o),
164	}
165	return json.Marshal(a)
166}
167
168type ModifyCustomEntrance struct {
169	MiniProgramsInfo *ModifyMiniAppInfo `json:"mini_programs_info,omitempty"`
170	Appid            *string            `json:"appid,omitempty"`
171	HallId           *string            `json:"hall_id,omitempty"`
172	CodeDisplayMode  *CodeDisplayMode   `json:"code_display_mode,omitempty"`
173}
174
175type DisplayPatternInfo struct {
176	Description     *string     `json:"description,omitempty"`
177	MerchantLogoUrl *string     `json:"merchant_logo_url,omitempty"`
178	MerchantName    *string     `json:"merchant_name,omitempty"`
179	BackgroundColor *string     `json:"background_color,omitempty"`
180	CouponImageUrl  *string     `json:"coupon_image_url,omitempty"`
181	FinderInfo      *FinderInfo `json:"finder_info,omitempty"`
182}
183
184type ModifyCouponUseRule struct {
185	UseMethod         *CouponUseMethod `json:"use_method,omitempty"`
186	MiniProgramsAppid *string          `json:"mini_programs_appid,omitempty"`
187	MiniProgramsPath  *string          `json:"mini_programs_path,omitempty"`
188}
189
190type ModifyStockSendRule struct {
191	NaturalPersonLimit *bool `json:"natural_person_limit,omitempty"`
192	PreventApiAbuse    *bool `json:"prevent_api_abuse,omitempty"`
193}
194
195type NotifyConfig struct {
196	NotifyAppid *string `json:"notify_appid,omitempty"`
197}
198
199type ModifyMiniAppInfo struct {
200	MiniProgramsAppid *string `json:"mini_programs_appid,omitempty"`
201	MiniProgramsPath  *string `json:"mini_programs_path,omitempty"`
202	EntranceWords     *string `json:"entrance_words,omitempty"`
203	GuidingWords      *string `json:"guiding_words,omitempty"`
204}
205
206type CodeDisplayMode string
207
208func (e CodeDisplayMode) Ptr() *CodeDisplayMode {
209	return &e
210}
211
212const (
213	CODEDISPLAYMODE_NOT_SHOW CodeDisplayMode = "NOT_SHOW"
214	CODEDISPLAYMODE_BARCODE  CodeDisplayMode = "BARCODE"
215	CODEDISPLAYMODE_QRCODE   CodeDisplayMode = "QRCODE"
216)
217
218type FinderInfo struct {
219	FinderId                 *string `json:"finder_id,omitempty"`
220	FinderVideoId            *string `json:"finder_video_id,omitempty"`
221	FinderVideoCoverImageUrl *string `json:"finder_video_cover_image_url,omitempty"`
222}
223
224type CouponUseMethod string
225
226func (e CouponUseMethod) Ptr() *CouponUseMethod {
227	return &e
228}
229
230const (
231	COUPONUSEMETHOD_OFF_LINE      CouponUseMethod = "OFF_LINE"
232	COUPONUSEMETHOD_MINI_PROGRAMS CouponUseMethod = "MINI_PROGRAMS"
233	COUPONUSEMETHOD_SELF_CONSUME  CouponUseMethod = "SELF_CONSUME"
234	COUPONUSEMETHOD_PAYMENT_CODE  CouponUseMethod = "PAYMENT_CODE"
235)
236