修改批次预算
更新时间:2024.09.20商户可以通过该接口修改批次单天发放上限数量或者批次最大发放数量
接口说明
支持商户:【普通商户】
请求方式:【PATCH】/v3/marketing/busifavor/stocks/{stock_id}/budget
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
path 路径参数
stock_id 必填 string
【批次号】批次号
body 包体参数
target_max_coupons 选填 integer
【目标批次最大发放个数】批次最大发放个数,target_max_coupons与target_max_coupons_by_day只能修改一个
注:目标批次即修改后的批次
current_max_coupons 选填 integer
【当前批次最大发放个数】当前批次最大发放个数,当传入target_max_coupons大于0时,current_max_coupons必传
注:当前批次即未修改的批次
target_max_coupons_by_day 选填 integer
【目标单天发放上限个数】单天发放上限个数,target_max_coupons与target_max_coupons_by_day只能修改一个
注:目标批次即修改后的批次
current_max_coupons_by_day 选填 integer
【当前单天发放上限个数】当前单天发放上限个数 ,当传入target_max_coupons_by_day大于0时,current_max_coupons_by_day必填
注:当前批次即未修改的批次
modify_budget_request_no 必填 string
【修改预算请求单据号】修改预算请求单据号
请求示例
PATCH
1curl -X PATCH \ 2 https://api.mch.weixin.qq.com/v3/marketing/busifavor/stocks/98065001/budget \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "target_max_coupons" : 3000, 8 "current_max_coupons" : 500, 9 "target_max_coupons_by_day" : 500, 10 "current_max_coupons_by_day" : 300, 11 "modify_budget_request_no" : "1002600620019090123143254436" 12 }' 13
需配合微信支付工具库 WXPayUtility 使用,请参考Java
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 ModifyBudget { 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}/budget"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/merchant/4013070756 32 ModifyBudget client = new ModifyBudget( 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 ModifyBudgetRequest request = new ModifyBudgetRequest(); 41 request.stockId = "98065001"; 42 request.targetMaxCoupons = 3000L; 43 request.currentMaxCoupons = 500L; 44 request.targetMaxCouponsByDay = 500L; 45 request.currentMaxCouponsByDay = 300L; 46 request.modifyBudgetRequestNo = "1002600620019090123143254436"; 47 try { 48 ModifyBudgetResponse response = client.run(request); 49 // TODO: 请求成功,继续业务逻辑 50 System.out.println(response); 51 } catch (WXPayUtility.ApiException e) { 52 // TODO: 请求失败,根据状态码执行不同的逻辑 53 e.printStackTrace(); 54 } 55 } 56 57 public ModifyBudgetResponse run(ModifyBudgetRequest request) { 58 String uri = PATH; 59 uri = uri.replace("{stock_id}", WXPayUtility.urlEncode(request.stockId)); 60 String reqBody = WXPayUtility.toJson(request); 61 62 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 63 reqBuilder.addHeader("Accept", "application/json"); 64 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 65 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 66 reqBuilder.addHeader("Content-Type", "application/json"); 67 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 68 reqBuilder.method(METHOD, requestBody); 69 Request httpRequest = reqBuilder.build(); 70 71 // 发送HTTP请求 72 OkHttpClient client = new OkHttpClient.Builder().build(); 73 try (Response httpResponse = client.newCall(httpRequest).execute()) { 74 String respBody = WXPayUtility.extractBody(httpResponse); 75 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 76 // 2XX 成功,验证应答签名 77 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 78 httpResponse.headers(), respBody); 79 80 // 从HTTP应答报文构建返回数据 81 return WXPayUtility.fromJson(respBody, ModifyBudgetResponse.class); 82 } else { 83 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 84 } 85 } catch (IOException e) { 86 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 87 } 88 } 89 90 private final String mchid; 91 private final String certificateSerialNo; 92 private final PrivateKey privateKey; 93 private final String wechatPayPublicKeyId; 94 private final PublicKey wechatPayPublicKey; 95 96 public ModifyBudget(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 97 this.mchid = mchid; 98 this.certificateSerialNo = certificateSerialNo; 99 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 100 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 101 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 102 } 103 104 public static class ModifyBudgetRequest { 105 @SerializedName("stock_id") 106 @Expose(serialize = false) 107 public String stockId; 108 109 @SerializedName("target_max_coupons") 110 public Long targetMaxCoupons; 111 112 @SerializedName("current_max_coupons") 113 public Long currentMaxCoupons; 114 115 @SerializedName("target_max_coupons_by_day") 116 public Long targetMaxCouponsByDay; 117 118 @SerializedName("current_max_coupons_by_day") 119 public Long currentMaxCouponsByDay; 120 121 @SerializedName("modify_budget_request_no") 122 public String modifyBudgetRequestNo; 123 } 124 125 public static class ModifyBudgetResponse { 126 @SerializedName("max_coupons") 127 public Long maxCoupons; 128 129 @SerializedName("max_coupons_by_day") 130 public Long maxCouponsByDay; 131 } 132 133} 134
需配合微信支付工具库 wxpay_utility 使用,请参考Go
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 := &ModifyBudgetRequest{ 28 StockId: wxpay_utility.String("98065001"), 29 TargetMaxCoupons: wxpay_utility.Int64(3000), 30 CurrentMaxCoupons: wxpay_utility.Int64(500), 31 TargetMaxCouponsByDay: wxpay_utility.Int64(500), 32 CurrentMaxCouponsByDay: wxpay_utility.Int64(300), 33 ModifyBudgetRequestNo: wxpay_utility.String("1002600620019090123143254436"), 34 } 35 36 response, err := ModifyBudget(config, request) 37 if err != nil { 38 fmt.Printf("请求失败: %+v\n", err) 39 // TODO: 请求失败,根据状态码执行不同的处理 40 return 41 } 42 43 // TODO: 请求成功,继续业务逻辑 44 fmt.Printf("请求成功: %+v\n", response) 45} 46 47func ModifyBudget(config *wxpay_utility.MchConfig, request *ModifyBudgetRequest) (response *ModifyBudgetResponse, err error) { 48 const ( 49 host = "https://api.mch.weixin.qq.com" 50 method = "PATCH" 51 path = "/v3/marketing/busifavor/stocks/{stock_id}/budget" 52 ) 53 54 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 55 if err != nil { 56 return nil, err 57 } 58 reqUrl.Path = strings.Replace(reqUrl.Path, "{stock_id}", url.PathEscape(*request.StockId), -1) 59 reqBody, err := json.Marshal(request) 60 if err != nil { 61 return nil, err 62 } 63 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Accept", "application/json") 68 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 69 httpRequest.Header.Set("Content-Type", "application/json") 70 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 71 if err != nil { 72 return nil, err 73 } 74 httpRequest.Header.Set("Authorization", authorization) 75 76 client := &http.Client{} 77 httpResponse, err := client.Do(httpRequest) 78 if err != nil { 79 return nil, err 80 } 81 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 82 if err != nil { 83 return nil, err 84 } 85 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 86 // 2XX 成功,验证应答签名 87 err = wxpay_utility.ValidateResponse( 88 config.WechatPayPublicKeyId(), 89 config.WechatPayPublicKey(), 90 &httpResponse.Header, 91 respBody, 92 ) 93 if err != nil { 94 return nil, err 95 } 96 response := &ModifyBudgetResponse{} 97 if err := json.Unmarshal(respBody, response); err != nil { 98 return nil, err 99 } 100 101 return response, nil 102 } else { 103 return nil, wxpay_utility.NewApiException( 104 httpResponse.StatusCode, 105 httpResponse.Header, 106 respBody, 107 ) 108 } 109} 110 111type ModifyBudgetRequest struct { 112 StockId *string `json:"stock_id,omitempty"` 113 TargetMaxCoupons *int64 `json:"target_max_coupons,omitempty"` 114 CurrentMaxCoupons *int64 `json:"current_max_coupons,omitempty"` 115 TargetMaxCouponsByDay *int64 `json:"target_max_coupons_by_day,omitempty"` 116 CurrentMaxCouponsByDay *int64 `json:"current_max_coupons_by_day,omitempty"` 117 ModifyBudgetRequestNo *string `json:"modify_budget_request_no,omitempty"` 118} 119 120func (o *ModifyBudgetRequest) MarshalJSON() ([]byte, error) { 121 type Alias ModifyBudgetRequest 122 a := &struct { 123 StockId *string `json:"stock_id,omitempty"` 124 *Alias 125 }{ 126 // 序列化时移除非 Body 字段 127 StockId: nil, 128 Alias: (*Alias)(o), 129 } 130 return json.Marshal(a) 131} 132 133type ModifyBudgetResponse struct { 134 MaxCoupons *int64 `json:"max_coupons,omitempty"` 135 MaxCouponsByDay *int64 `json:"max_coupons_by_day,omitempty"` 136} 137
应答参数
200 OK
max_coupons 必填 integer
【批次当前最大发放个数】批次最大发放个数
max_coupons_by_day 选填 integer
【当前单天发放上限个数】当前单天发放上限个数
应答示例
200 OK
1{ 2 "max_coupons" : 300, 3 "max_coupons_by_day" : 100 4} 5
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
403 | RULE_LIMIT | 批次库存的当前值错误,请获取批次详情查看最新值 | 批次库存的当前值错误,请获取批次详情查看最新值 |
403 | RULE_LIMIT | 仅创建方有权限使券失效 | 仅创建方有权限使券失效 |
403 | RULE_LIMIT | 批次正在修改中,请稍后重试 | 批次正在修改中,请稍后重试 |
403 | RULE_LIMIT | 目标库存数目不能小于批次已发放库存数目 | 目标库存数目不能小于批次已发放库存数目 |
404 | RESOURCE_NOT_EXISTS | 批次不存在 | 请检查批次ID |
404 | RESOURCE_NOT_EXISTS | 批次已过期 | 只能修改运行中的批次预算 |
429 | FREQUENCY_LIMITED | 调用太频繁,请降低调用接口频率 | 调用太频繁,请降低调用接口频率 |