解锁公益捐赠预算
更新时间:2025.07.10解锁公益捐赠预算
注:单个商户的接口频率限制为100次/s
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/fund-app/mch-transfer/partner/charity-budget/{out_budget_no}/unlock
请求域名:【主域名】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 路径参数
out_budget_no 必填 string(32)
【商户预算单号】 服务商系统内部预算单号,此参数只能由数字、大小写字母组成,服务商系统内部唯一
body 包体参数
sponsor_mchid 必填 string(32)
【出资商户号】 出资商户号
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/partner/charity-budget/budget202506300102/unlock \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "sponsor_mchid" : "1900001109" 8 }' 9
需配合微信支付工具库 WXPayUtility 使用,请参考Java
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 UnlockBudget { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/v3/fund-app/mch-transfer/partner/charity-budget/{out_budget_no}/unlock"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 UnlockBudget client = new UnlockBudget( 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 UnlockBudgetRequest request = new UnlockBudgetRequest(); 41 request.outBudgetNo = "budget202506300102"; 42 request.sponsorMchid = "1900001109"; 43 try { 44 BudgetInfo 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 BudgetInfo run(UnlockBudgetRequest request) { 54 String uri = PATH; 55 uri = uri.replace("{out_budget_no}", WXPayUtility.urlEncode(request.outBudgetNo)); 56 String reqBody = WXPayUtility.toJson(request); 57 58 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 59 reqBuilder.addHeader("Accept", "application/json"); 60 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 61 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 62 reqBuilder.addHeader("Content-Type", "application/json"); 63 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 64 reqBuilder.method(METHOD, requestBody); 65 Request httpRequest = reqBuilder.build(); 66 67 // 发送HTTP请求 68 OkHttpClient client = new OkHttpClient.Builder().build(); 69 try (Response httpResponse = client.newCall(httpRequest).execute()) { 70 String respBody = WXPayUtility.extractBody(httpResponse); 71 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 72 // 2XX 成功,验证应答签名 73 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 74 httpResponse.headers(), respBody); 75 76 // 从HTTP应答报文构建返回数据 77 return WXPayUtility.fromJson(respBody, BudgetInfo.class); 78 } else { 79 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 80 } 81 } catch (IOException e) { 82 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 83 } 84 } 85 86 private final String mchid; 87 private final String certificateSerialNo; 88 private final PrivateKey privateKey; 89 private final String wechatPayPublicKeyId; 90 private final PublicKey wechatPayPublicKey; 91 92 public UnlockBudget(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 93 this.mchid = mchid; 94 this.certificateSerialNo = certificateSerialNo; 95 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 96 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 97 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 98 } 99 100 public static class UnlockBudgetRequest { 101 @SerializedName("out_budget_no") 102 @Expose(serialize = false) 103 public String outBudgetNo; 104 105 @SerializedName("sponsor_mchid") 106 public String sponsorMchid; 107 } 108 109 public static class BudgetInfo { 110 @SerializedName("sp_mchid") 111 public String spMchid; 112 113 @SerializedName("out_budget_no") 114 public String outBudgetNo; 115 116 @SerializedName("budget_id") 117 public String budgetId; 118 119 @SerializedName("amount") 120 public Long amount; 121 122 @SerializedName("sponsor_mchid") 123 public String sponsorMchid; 124 125 @SerializedName("activity_name") 126 public String activityName; 127 128 @SerializedName("activity_remark") 129 public String activityRemark; 130 131 @SerializedName("state") 132 public BudgetOrderState state; 133 134 @SerializedName("unlock_remark") 135 public String unlockRemark; 136 137 @SerializedName("locked_time") 138 public String lockedTime; 139 140 @SerializedName("finished_time") 141 public String finishedTime; 142 } 143 144 public enum BudgetOrderState { 145 @SerializedName("FINISHED") 146 FINISHED, 147 @SerializedName("UNLOCKING") 148 UNLOCKING 149 } 150 151} 152
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/v3/partner/4015119446 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/partner/4013080340 15 config, err := wxpay_utility.CreateMchConfig( 16 "19xxxxxxxx", // 商户号,是由微信支付系统生成并分配给每个商户的唯一标识符,商户号获取方式参考 https://pay.weixin.qq.com/doc/v3/partner/4013080340 17 "1DDE55AD98Exxxxxxxxxx", // 商户API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013058924 18 "/path/to/apiclient_key.pem", // 商户API证书私钥文件路径,本地文件路径 19 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/v3/partner/4013038589 20 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 21 ) 22 if err != nil { 23 fmt.Println(err) 24 return 25 } 26 27 request := &UnlockBudgetRequest{ 28 OutBudgetNo: wxpay_utility.String("budget202506300102"), 29 SponsorMchid: wxpay_utility.String("1900001109"), 30 } 31 32 response, err := UnlockBudget(config, request) 33 if err != nil { 34 fmt.Printf("请求失败: %+v\n", err) 35 // TODO: 请求失败,根据状态码执行不同的处理 36 return 37 } 38 39 // TODO: 请求成功,继续业务逻辑 40 fmt.Printf("请求成功: %+v\n", response) 41} 42 43func UnlockBudget(config *wxpay_utility.MchConfig, request *UnlockBudgetRequest) (response *BudgetInfo, err error) { 44 const ( 45 host = "https://api.mch.weixin.qq.com" 46 method = "POST" 47 path = "/v3/fund-app/mch-transfer/partner/charity-budget/{out_budget_no}/unlock" 48 ) 49 50 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 51 if err != nil { 52 return nil, err 53 } 54 reqUrl.Path = strings.Replace(reqUrl.Path, "{out_budget_no}", url.PathEscape(*request.OutBudgetNo), -1) 55 reqBody, err := json.Marshal(request) 56 if err != nil { 57 return nil, err 58 } 59 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 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 httpRequest.Header.Set("Content-Type", "application/json") 66 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 67 if err != nil { 68 return nil, err 69 } 70 httpRequest.Header.Set("Authorization", authorization) 71 72 client := &http.Client{} 73 httpResponse, err := client.Do(httpRequest) 74 if err != nil { 75 return nil, err 76 } 77 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 78 if err != nil { 79 return nil, err 80 } 81 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 82 // 2XX 成功,验证应答签名 83 err = wxpay_utility.ValidateResponse( 84 config.WechatPayPublicKeyId(), 85 config.WechatPayPublicKey(), 86 &httpResponse.Header, 87 respBody, 88 ) 89 if err != nil { 90 return nil, err 91 } 92 response := &BudgetInfo{} 93 if err := json.Unmarshal(respBody, response); err != nil { 94 return nil, err 95 } 96 97 return response, nil 98 } else { 99 return nil, wxpay_utility.NewApiException( 100 httpResponse.StatusCode, 101 httpResponse.Header, 102 respBody, 103 ) 104 } 105} 106 107type UnlockBudgetRequest struct { 108 OutBudgetNo *string `json:"out_budget_no,omitempty"` 109 SponsorMchid *string `json:"sponsor_mchid,omitempty"` 110} 111 112func (o *UnlockBudgetRequest) MarshalJSON() ([]byte, error) { 113 type Alias UnlockBudgetRequest 114 a := &struct { 115 OutBudgetNo *string `json:"out_budget_no,omitempty"` 116 *Alias 117 }{ 118 // 序列化时移除非 Body 字段 119 OutBudgetNo: nil, 120 Alias: (*Alias)(o), 121 } 122 return json.Marshal(a) 123} 124 125type BudgetInfo struct { 126 SpMchid *string `json:"sp_mchid,omitempty"` 127 OutBudgetNo *string `json:"out_budget_no,omitempty"` 128 BudgetId *string `json:"budget_id,omitempty"` 129 Amount *int64 `json:"amount,omitempty"` 130 SponsorMchid *string `json:"sponsor_mchid,omitempty"` 131 ActivityName *string `json:"activity_name,omitempty"` 132 ActivityRemark *string `json:"activity_remark,omitempty"` 133 State *BudgetOrderState `json:"state,omitempty"` 134 UnlockRemark *string `json:"unlock_remark,omitempty"` 135 LockedTime *string `json:"locked_time,omitempty"` 136 FinishedTime *string `json:"finished_time,omitempty"` 137} 138 139type BudgetOrderState string 140 141func (e BudgetOrderState) Ptr() *BudgetOrderState { 142 return &e 143} 144 145const ( 146 BUDGETORDERSTATE_FINISHED BudgetOrderState = "FINISHED" 147 BUDGETORDERSTATE_UNLOCKING BudgetOrderState = "UNLOCKING" 148) 149
应答参数
200 OK
sp_mchid 必填 string(32)
【服务商商户号】 服务商商户号
out_budget_no 必填 string(32)
【商户预算单号】 服务商系统内部预算单号,此参数只能由数字、大小写字母组成,在服务商系统内部唯一。
budget_id 必填 string(32)
【微信支付预算单号】 微信支付预算单号,微信系统返回的唯一标识。
amount 必填 integer
【活动总金额】 活动预算总金额,单位为“分”。
sponsor_mchid 必填 string(32)
【出资商户号】 出资商户号
activity_name 必填 string(32)
【活动名称】 活动名称
activity_remark 必填 string(64)
【活动说明】 活动说明
state 必填 string
【预算单状态】 预算单状态
可选取值
FINISHED: 已完成(终态),预算捐赠完成或者解锁后,预算单会由LOCKED转变为FINISHED状态UNLOCKING: 待释放,受理解锁预算单成功后,预算单会由LOCKED转变为UNLOCKING状态
unlock_remark 必填 string(32)
【撤销说明】 预算解锁时,商户传入的解锁说明
locked_time 必填 string
【资金锁定时间】 资金锁定时间,遵循rfc3339标准格式:yyyy-MM-DDThh:mm:ss+TIMEZONE
finished_time 必填 string
【完成时间】 完成时间,遵循rfc3339标准格式:yyyy-MM-DDThh:mm:ss+TIMEZONE
应答示例
200 OK
1{ 2 "sp_mchid" : "1900001109", 3 "out_budget_no" : "budget202506300102", 4 "budget_id" : "1182020050700019480001", 5 "amount" : 20000000, 6 "sponsor_mchid" : "1900001109", 7 "activity_name" : "公益企业配捐活动", 8 "activity_remark" : "公益活动开始于9月1日,帮助困难儿童筹款活动", 9 "state" : "FINISHED", 10 "unlock_remark" : "公益活动结束,解锁资金", 11 "locked_time" : "2025-06-21T13:29:35.120+08:00", 12 "finished_time" : "2025-06-21T13:29:35.120+08:00" 13} 14
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

