发起公益捐赠
更新时间:2025.07.10服务商商户可通过此接口发起公益捐赠
接口返回的HTTP状态码及错误码,仅代表本次请求的结果,不能代表订单状态。
接口返回的HTTP状态码为200,且状态为ACCEPT时,可认为发起公益捐赠。
接口返回的HTTP状态码不为200时,请商户务必不要立即更换商户订单单号重试。可根据错误码列表中的描述和接口返回的信息进行处理,并在查询原订单结果为失败时,再更换商户订单号进行重试。否则会有重复捐赠的资金风险。
注:单个商户的接口频率限制为100次/s
接口说明
支持商户:【普通服务商】
请求方式:【POST】/v3/fund-app/mch-transfer/partner/charity-transfer-bills
请求域名:【主域名】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
body 包体参数
out_budget_no 必填 string(32)
【商户预算单号】 服务商系统内部预算单号,此参数只能由数字、大小写字母组成,在服务商系统内部唯一
out_transfer_no 必填 string(32)
【商户公益捐赠单号】 服务商系统内部公益捐赠单号,此参数只能由数字、大小写字母组成,在服务商系统内部唯一
transaction_info 选填 object
【关联的交易单号】 若捐赠金额超过1000元,则必须传入与该笔捐赠相关联的交易单号,且当前捐赠的金额不得超过该交易单的交易金额的十倍。
属性 | |
transaction_type 必填 string 【订单类型】 订单类型 可选取值
transaction_id 必填 string 【订单号】 与传入订单类型相对应交易订单单号 |
sponsor_mchid 必填 string(32)
【出资商户号】 出资捐款的商户号
receive_mchid 必填 string(32)
【收款商户号】 接收捐款的商户号
amount 必填 integer
【金额】 单笔捐赠的金额,单位为“分”。
transfer_remark 必填 string(32)
【捐赠备注】 备注,面向收款商户号展示
请求示例
需配合微信支付工具库 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 TransferCharityDonation { 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-transfer-bills"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340 32 TransferCharityDonation client = new TransferCharityDonation( 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 TransferCharityDonationRequest request = new TransferCharityDonationRequest(); 41 request.outBudgetNo = "budget202506030102"; 42 request.outTransferNo = "trans202506300102"; 43 request.transactionInfo = new TransactionInfo(); 44 request.transactionInfo.transactionType = TransactionType.WXPAY; 45 request.transactionInfo.transactionId = "4217752501201407033233368018"; 46 request.sponsorMchid = "1900001109"; 47 request.receiveMchid = "1900001109"; 48 request.amount = 10000L; 49 request.transferRemark = "帮助受助群体爱心捐款"; 50 try { 51 TransferCharityBillEntity response = client.run(request); 52 53 // TODO: 请求成功,继续业务逻辑 54 System.out.println(response); 55 } catch (WXPayUtility.ApiException e) { 56 // TODO: 请求失败,根据状态码执行不同的逻辑 57 e.printStackTrace(); 58 } 59 } 60 61 public TransferCharityBillEntity run(TransferCharityDonationRequest request) { 62 String uri = PATH; 63 String reqBody = WXPayUtility.toJson(request); 64 65 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 66 reqBuilder.addHeader("Accept", "application/json"); 67 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 68 reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 69 reqBuilder.addHeader("Content-Type", "application/json"); 70 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 71 reqBuilder.method(METHOD, requestBody); 72 Request httpRequest = reqBuilder.build(); 73 74 // 发送HTTP请求 75 OkHttpClient client = new OkHttpClient.Builder().build(); 76 try (Response httpResponse = client.newCall(httpRequest).execute()) { 77 String respBody = WXPayUtility.extractBody(httpResponse); 78 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 79 // 2XX 成功,验证应答签名 80 WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 81 httpResponse.headers(), respBody); 82 83 // 从HTTP应答报文构建返回数据 84 return WXPayUtility.fromJson(respBody, TransferCharityBillEntity.class); 85 } else { 86 throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 87 } 88 } catch (IOException e) { 89 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 90 } 91 } 92 93 private final String mchid; 94 private final String certificateSerialNo; 95 private final PrivateKey privateKey; 96 private final String wechatPayPublicKeyId; 97 private final PublicKey wechatPayPublicKey; 98 99 public TransferCharityDonation(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 100 this.mchid = mchid; 101 this.certificateSerialNo = certificateSerialNo; 102 this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath); 103 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 104 this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 105 } 106 107 public static class TransferCharityDonationRequest { 108 @SerializedName("out_budget_no") 109 public String outBudgetNo; 110 111 @SerializedName("out_transfer_no") 112 public String outTransferNo; 113 114 @SerializedName("transaction_info") 115 public TransactionInfo transactionInfo; 116 117 @SerializedName("sponsor_mchid") 118 public String sponsorMchid; 119 120 @SerializedName("receive_mchid") 121 public String receiveMchid; 122 123 @SerializedName("amount") 124 public Long amount; 125 126 @SerializedName("transfer_remark") 127 public String transferRemark; 128 } 129 130 public static class TransferCharityBillEntity { 131 @SerializedName("out_budget_no") 132 public String outBudgetNo; 133 134 @SerializedName("budget_id") 135 public String budgetId; 136 137 @SerializedName("out_transfer_no") 138 public String outTransferNo; 139 140 @SerializedName("transfer_id") 141 public String transferId; 142 143 @SerializedName("amount") 144 public Long amount; 145 146 @SerializedName("transfer_remark") 147 public String transferRemark; 148 149 @SerializedName("receive_mchid") 150 public String receiveMchid; 151 152 @SerializedName("state") 153 public TransferBillStatus state; 154 155 @SerializedName("create_time") 156 public String createTime; 157 158 @SerializedName("success_time") 159 public String successTime; 160 } 161 162 public static class TransactionInfo { 163 @SerializedName("transaction_type") 164 public TransactionType transactionType; 165 166 @SerializedName("transaction_id") 167 public String transactionId; 168 } 169 170 public enum TransferBillStatus { 171 @SerializedName("ACCEPTED") 172 ACCEPTED, 173 @SerializedName("SUCCESS") 174 SUCCESS, 175 @SerializedName("CLOSE") 176 CLOSE 177 } 178 179 public enum TransactionType { 180 @SerializedName("WXPAY") 181 WXPAY 182 } 183 184} 185
需配合微信支付工具库 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) 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 := &TransferCharityDonationRequest{ 27 OutBudgetNo: wxpay_utility.String("budget202506030102"), 28 OutTransferNo: wxpay_utility.String("trans202506300102"), 29 TransactionInfo: &TransactionInfo{ 30 TransactionType: TRANSACTIONTYPE_WXPAY.Ptr(), 31 TransactionId: wxpay_utility.String("4217752501201407033233368018"), 32 }, 33 SponsorMchid: wxpay_utility.String("1900001109"), 34 ReceiveMchid: wxpay_utility.String("1900001109"), 35 Amount: wxpay_utility.Int64(10000), 36 TransferRemark: wxpay_utility.String("帮助受助群体爱心捐款"), 37 } 38 39 response, err := TransferCharityDonation(config, request) 40 if err != nil { 41 fmt.Printf("请求失败: %+v\n", err) 42 // TODO: 请求失败,根据状态码执行不同的处理 43 return 44 } 45 46 // TODO: 请求成功,继续业务逻辑 47 fmt.Printf("请求成功: %+v\n", response) 48} 49 50func TransferCharityDonation(config *wxpay_utility.MchConfig, request *TransferCharityDonationRequest) (response *TransferCharityBillEntity, err error) { 51 const ( 52 host = "https://api.mch.weixin.qq.com" 53 method = "POST" 54 path = "/v3/fund-app/mch-transfer/partner/charity-transfer-bills" 55 ) 56 57 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 58 if err != nil { 59 return nil, err 60 } 61 reqBody, err := json.Marshal(request) 62 if err != nil { 63 return nil, err 64 } 65 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 66 if err != nil { 67 return nil, err 68 } 69 httpRequest.Header.Set("Accept", "application/json") 70 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 71 httpRequest.Header.Set("Content-Type", "application/json") 72 authorization, err := wxpay_utility.BuildAuthorization(config.MchId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 73 if err != nil { 74 return nil, err 75 } 76 httpRequest.Header.Set("Authorization", authorization) 77 78 client := &http.Client{} 79 httpResponse, err := client.Do(httpRequest) 80 if err != nil { 81 return nil, err 82 } 83 84 respBody, err := wxpay_utility.ExtractResponseBody(httpResponse) 85 if err != nil { 86 return nil, err 87 } 88 89 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 90 // 2XX 成功,验证应答签名 91 err = wxpay_utility.ValidateResponse( 92 config.WechatPayPublicKeyId(), 93 config.WechatPayPublicKey(), 94 &httpResponse.Header, 95 respBody, 96 ) 97 if err != nil { 98 return nil, err 99 } 100 101 if err := json.Unmarshal(respBody, response); err != nil { 102 return nil, err 103 } 104 105 return response, nil 106 } else { 107 return nil, wxpay_utility.NewApiException( 108 httpResponse.StatusCode, 109 httpResponse.Header, 110 respBody, 111 ) 112 } 113} 114 115type TransferCharityDonationRequest struct { 116 OutBudgetNo *string `json:"out_budget_no,omitempty"` 117 OutTransferNo *string `json:"out_transfer_no,omitempty"` 118 TransactionInfo *TransactionInfo `json:"transaction_info,omitempty"` 119 SponsorMchid *string `json:"sponsor_mchid,omitempty"` 120 ReceiveMchid *string `json:"receive_mchid,omitempty"` 121 Amount *int64 `json:"amount,omitempty"` 122 TransferRemark *string `json:"transfer_remark,omitempty"` 123} 124 125type TransferCharityBillEntity struct { 126 OutBudgetNo *string `json:"out_budget_no,omitempty"` 127 BudgetId *string `json:"budget_id,omitempty"` 128 OutTransferNo *string `json:"out_transfer_no,omitempty"` 129 TransferId *string `json:"transfer_id,omitempty"` 130 Amount *int64 `json:"amount,omitempty"` 131 TransferRemark *string `json:"transfer_remark,omitempty"` 132 ReceiveMchid *string `json:"receive_mchid,omitempty"` 133 State *TransferBillStatus `json:"state,omitempty"` 134 CreateTime *string `json:"create_time,omitempty"` 135 SuccessTime *string `json:"success_time,omitempty"` 136} 137 138type TransactionInfo struct { 139 TransactionType *TransactionType `json:"transaction_type,omitempty"` 140 TransactionId *string `json:"transaction_id,omitempty"` 141} 142 143type TransferBillStatus string 144 145func (e TransferBillStatus) Ptr() *TransferBillStatus { 146 return &e 147} 148 149const ( 150 TRANSFERBILLSTATUS_ACCEPTED TransferBillStatus = "ACCEPTED" 151 TRANSFERBILLSTATUS_SUCCESS TransferBillStatus = "SUCCESS" 152 TRANSFERBILLSTATUS_CLOSE TransferBillStatus = "CLOSE" 153) 154 155type TransactionType string 156 157func (e TransactionType) Ptr() *TransactionType { 158 return &e 159} 160 161const ( 162 TRANSACTIONTYPE_WXPAY TransactionType = "WXPAY" 163) 164
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/v3/fund-app/mch-transfer/partner/charity-transfer-bills \ 3 -H "Authorization: WECHATPAY2-SHA256-RSA2048 mchid=\"1900000001\",..." \ 4 -H "Accept: application/json" \ 5 -H "Content-Type: application/json" \ 6 -d '{ 7 "out_budget_no" : "budget202506030102", 8 "out_transfer_no" : "trans202506300102", 9 "transaction_info" : { 10 "transaction_type" : "WXPAY", 11 "transaction_id" : "4217752501201407033233368018" 12 }, 13 "sponsor_mchid" : "1900001109", 14 "receive_mchid" : "1900001109", 15 "amount" : 10000, 16 "transfer_remark" : "帮助受助群体爱心捐款" 17 }' 18
应答参数
200 OK
out_budget_no 必填 string(32)
【商户预算单号】 商户预算单号
budget_id 必填 string(32)
【微信支付预算单号】 微信支付预算单号
out_transfer_no 必填 string(32)
【商户公益捐赠单号】 商户公益捐赠单号
transfer_id 必填 string(32)
【微信支付公益捐赠单号】 微信支付公益捐赠单号
amount 必填 integer
【捐赠金额】 单位为“分”。
transfer_remark 必填 string(32)
【捐赠备注】 捐赠备注
receive_mchid 必填 string(32)
【收款商户号】 收款商户号
state 必填 string
【捐赠状态】 捐赠状态
可选取值
ACCEPTED
: 转账已受理SUCCESS
: 转账成功CLOSE
: 已关闭
create_time 必填 string
【捐赠单创建时间】 捐赠单创建时间,遵循rfc3339标准格式:yyyy-MM-DDThh:mm:ss+TIMEZONE
success_time 选填 string
【捐赠完成时间】 捐赠完成时间,仅当转账成功时返回,遵循rfc3339标准格式:yyyy-MM-DDThh:mm:ss+TIMEZONE
应答示例
200 OK
1{ 2 "out_budget_no" : "budget202506030102", 3 "budget_id" : "1182020050700019480001", 4 "out_transfer_no" : "trans202506300102", 5 "transfer_id" : "4217752501201407033233368018", 6 "amount" : 10000, 7 "transfer_remark" : "帮助受助群体爱心捐款", 8 "receive_mchid" : "1900001109", 9 "state" : "SUCCESS", 10 "create_time" : "2025-06-21T13:29:35.120+08:00", 11 "success_time" : "2025-06-21T13:29:35.120+08:00" 12} 13
错误码
公共错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
400 | PARAM_ERROR | 参数错误 | 请根据错误提示正确传入参数 |
400 | INVALID_REQUEST | HTTP 请求不符合微信支付 APIv3 接口规则 | 请参阅 接口规则 |
401 | SIGN_ERROR | 验证不通过 | 请参阅 签名常见问题 |
500 | SYSTEM_ERROR | 系统异常,请稍后重试 | 请稍后重试 |
业务错误码
状态码 | 错误码 | 描述 | 解决方案 |
---|---|---|---|
429 | RATELIMIT_EXCEEDED | 请求接口频率过快 | 降低频率,稍后重试 |
403 | NOT_ENOUGH | 预算不足 | 确认出资商户预算情况,补充预算 |
400 | INVALID_REQUEST | 请求不符合业务规则 | 请参阅 产品介绍、开发指引 和 接口规则 |