设置投放计划回调地址
更新时间:2026.03.16投放计划创建后,如果设置了回调地址,当投放计划的状态 plan_state 或者审批状态 audit_state 发生变更时,会回调给品牌方。
接口说明
支持商户:【品牌商户】
请求方式:【POST】/brand/marketing/delivery-plan/notify-url
请求域名:【主域名】https://api.mch.weixin.qq.com 使用该域名将访问就近的接入点
【备域名】https://api2.mch.weixin.qq.com 使用该域名将访问异地的接入点 ,指引点击查看
接口限频:1/秒(品牌ID维度)
请求参数
Header HTTP头参数
Authorization 必填 string
请参考签名认证生成认证信息
Accept 必填 string
请设置为application/json
Content-Type 必填 string
请设置为application/json
Wechatpay-Serial 必填 string
【微信支付公钥ID】 请传入brand_id对应的微信支付公钥ID,接口将会校验两者的关联关系,参考微信支付公钥产品简介及使用说明获取微信支付公钥ID和相关的介绍。以下两种场景将使用到微信支付公钥: 1、接收到接口的返回内容,需要使用微信支付公钥进行验签; 2、调用含有敏感信息参数(如姓名、身份证号码)的接口时,需要使用微信支付公钥加密敏感信息后再传输参数,加密指引请参考微信支付公钥加密敏感信息指引。
body 包体参数
notify_url 必填 string(256)
【通知回调地址】 通知回调地址,需按照notify_url填写注意事项规范填写。
请求示例
POST
1curl -X POST \ 2 https://api.mch.weixin.qq.com/brand/marketing/delivery-plan/notify-url \ 3 -H "Authorization: WECHATPAY-BRAND-SHA256-RSA2048 brand_id=\"XXXX\",..." \ 4 -H "Accept: application/json" \ 5 -H "Wechatpay-Serial: PUB_KEY_ID_XXXX" \ 6 -H "Content-Type: application/json" \ 7 -d '{ 8 "notify_url" : "https://www.example.com/notify" 9 }' 10
需配合微信支付工具库 WXPayUtility 使用,请参考Java
1package com.java.demo; 2 3import com.java.utils.WXPayBrandUtility; // 引用微信支付工具库,参考:https://pay.weixin.qq.com/doc/brand/4015826861 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 SetCallbackUrl { 26 private static String HOST = "https://api.mch.weixin.qq.com"; 27 private static String METHOD = "POST"; 28 private static String PATH = "/brand/marketing/delivery-plan/notify-url"; 29 30 public static void main(String[] args) { 31 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 32 SetCallbackUrl client = new SetCallbackUrl( 33 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 34 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 35 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 36 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 37 "/path/to/wxp_pub.pem" // 微信支付公钥文件路径,本地文件路径 38 ); 39 40 SetNotifyUrlRequest request = new SetNotifyUrlRequest(); 41 request.notifyUrl = "https://www.example.com/notify"; 42 try { 43 SetNotifyUrlResponse response = client.run(request); 44 // TODO: 请求成功,继续业务逻辑 45 System.out.println(response); 46 } catch (WXPayBrandUtility.ApiException e) { 47 // TODO: 请求失败,根据状态码执行不同的逻辑 48 e.printStackTrace(); 49 } 50 } 51 52 public SetNotifyUrlResponse run(SetNotifyUrlRequest request) { 53 String uri = PATH; 54 String reqBody = WXPayBrandUtility.toJson(request); 55 56 Request.Builder reqBuilder = new Request.Builder().url(HOST + uri); 57 reqBuilder.addHeader("Accept", "application/json"); 58 reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId); 59 reqBuilder.addHeader("Authorization", WXPayBrandUtility.buildAuthorization(brand_id, certificateSerialNo,privateKey, METHOD, uri, reqBody)); 60 reqBuilder.addHeader("Content-Type", "application/json"); 61 RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody); 62 reqBuilder.method(METHOD, requestBody); 63 Request httpRequest = reqBuilder.build(); 64 65 // 发送HTTP请求 66 OkHttpClient client = new OkHttpClient.Builder().build(); 67 try (Response httpResponse = client.newCall(httpRequest).execute()) { 68 String respBody = WXPayBrandUtility.extractBody(httpResponse); 69 if (httpResponse.code() >= 200 && httpResponse.code() < 300) { 70 // 2XX 成功,验证应答签名 71 WXPayBrandUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey, 72 httpResponse.headers(), respBody); 73 74 // 从HTTP应答报文构建返回数据 75 return WXPayBrandUtility.fromJson(respBody, SetNotifyUrlResponse.class); 76 } else { 77 throw new WXPayBrandUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers()); 78 } 79 } catch (IOException e) { 80 throw new UncheckedIOException("Sending request to " + uri + " failed.", e); 81 } 82 } 83 84 private final String brand_id; 85 private final String certificateSerialNo; 86 private final PrivateKey privateKey; 87 private final String wechatPayPublicKeyId; 88 private final PublicKey wechatPayPublicKey; 89 90 public SetCallbackUrl(String brand_id, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) { 91 this.brand_id = brand_id; 92 this.certificateSerialNo = certificateSerialNo; 93 this.privateKey = WXPayBrandUtility.loadPrivateKeyFromPath(privateKeyFilePath); 94 this.wechatPayPublicKeyId = wechatPayPublicKeyId; 95 this.wechatPayPublicKey = WXPayBrandUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath); 96 } 97 98 public static class SetNotifyUrlRequest { 99 @SerializedName("notify_url") 100 public String notifyUrl; 101 } 102 103 public static class SetNotifyUrlResponse { 104 @SerializedName("notify_url") 105 public String notifyUrl; 106 } 107 108} 109
需配合微信支付工具库 wxpay_utility 使用,请参考Go
1package main 2 3import ( 4 "bytes" 5 "demo/wxpay_brand_utility" // 引用微信支付工具库,参考 https://pay.weixin.qq.com/doc/brand/4015826866 6 "encoding/json" 7 "fmt" 8 "net/http" 9 "net/url" 10) 11 12func main() { 13 // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/brand/4015415289 14 config, err := wxpay_brand_utility.CreateBrandConfig( 15 "xxxxxxxx", // 品牌ID,是由微信支付系统生成并分配给每个品牌方的唯一标识符,品牌ID获取方式参考 https://pay.weixin.qq.com/doc/brand/4015415289 16 "1DDE55AD98Exxxxxxxxxx", // 品牌API证书序列号,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015407570 17 "/path/to/apiclient_key.pem", // 品牌API证书私钥文件路径,本地文件路径 18 "PUB_KEY_ID_xxxxxxxxxxxxx", // 微信支付公钥ID,如何获取请参考 https://pay.weixin.qq.com/doc/brand/4015453439 19 "/path/to/wxp_pub.pem", // 微信支付公钥文件路径,本地文件路径 20 ) 21 if err != nil { 22 fmt.Println(err) 23 return 24 } 25 26 request := &SetNotifyUrlRequest{ 27 NotifyUrl: wxpay_brand_utility.String("https://www.example.com/notify"), 28 } 29 30 response, err := SetCallbackUrl(config, request) 31 if err != nil { 32 fmt.Printf("请求失败: %+v\n", err) 33 // TODO: 请求失败,根据状态码执行不同的处理 34 return 35 } 36 37 // TODO: 请求成功,继续业务逻辑 38 fmt.Printf("请求成功: %+v\n", response) 39} 40 41func SetCallbackUrl(config *wxpay_brand_utility.BrandConfig, request *SetNotifyUrlRequest) (response *SetNotifyUrlResponse, err error) { 42 const ( 43 host = "https://api.mch.weixin.qq.com" 44 method = "POST" 45 path = "/brand/marketing/delivery-plan/notify-url" 46 ) 47 48 reqUrl, err := url.Parse(fmt.Sprintf("%s%s", host, path)) 49 if err != nil { 50 return nil, err 51 } 52 reqBody, err := json.Marshal(request) 53 if err != nil { 54 return nil, err 55 } 56 httpRequest, err := http.NewRequest(method, reqUrl.String(), bytes.NewReader(reqBody)) 57 if err != nil { 58 return nil, err 59 } 60 httpRequest.Header.Set("Accept", "application/json") 61 httpRequest.Header.Set("Wechatpay-Serial", config.WechatPayPublicKeyId()) 62 httpRequest.Header.Set("Content-Type", "application/json") 63 authorization, err := wxpay_brand_utility.BuildAuthorization(config.BrandId(), config.CertificateSerialNo(), config.PrivateKey(), method, reqUrl.RequestURI(), reqBody) 64 if err != nil { 65 return nil, err 66 } 67 httpRequest.Header.Set("Authorization", authorization) 68 69 client := &http.Client{} 70 httpResponse, err := client.Do(httpRequest) 71 if err != nil { 72 return nil, err 73 } 74 respBody, err := wxpay_brand_utility.ExtractResponseBody(httpResponse) 75 if err != nil { 76 return nil, err 77 } 78 if httpResponse.StatusCode >= 200 && httpResponse.StatusCode < 300 { 79 // 2XX 成功,验证应答签名 80 err = wxpay_brand_utility.ValidateResponse( 81 config.WechatPayPublicKeyId(), 82 config.WechatPayPublicKey(), 83 &httpResponse.Header, 84 respBody, 85 ) 86 if err != nil { 87 return nil, err 88 } 89 response := &SetNotifyUrlResponse{} 90 if err := json.Unmarshal(respBody, response); err != nil { 91 return nil, err 92 } 93 94 return response, nil 95 } else { 96 return nil, wxpay_brand_utility.NewApiException( 97 httpResponse.StatusCode, 98 httpResponse.Header, 99 respBody, 100 ) 101 } 102} 103 104type SetNotifyUrlRequest struct { 105 NotifyUrl *string `json:"notify_url,omitempty"` 106} 107 108type SetNotifyUrlResponse struct { 109 NotifyUrl *string `json:"notify_url,omitempty"` 110} 111
应答参数
200 OK
notify_url 必填 string(256)
【通知回调地址】 通知回调地址,投放计划发生状态变更时通知品牌方的通知地址
应答示例
200 OK
1{ 2 "notify_url" : "https://www.example.com/notify" 3} 4
错误码
以下是本接口返回的错误码列表。详细错误码规则,请参考微信支付接口规则-错误码和错误提示

