添加分账接收方

更新时间:2025.08.21

服务商可通过此接口添加分账接收方,建立分账接收方列表。连锁加盟模式下,服务商添加的分账接收方统一在品牌主商户号维度进行管理。



注意:

  1. 添加接收方成功后,后续通过发起分账请求,品牌主及门店可以直接向分账接收方列表中的接收方进行分账。

  2. 品牌主商户号,系统默认添加进入分账接收方列表,无需重复添加。

  3. 默认支持品牌主商户号向品牌下加盟的门店商户号进行分账,无需添加门店为分账接收方;上述条件需要品牌主商户号和门店商户号具有相同的服务商。其他门店需要参与分账的场景,仍需将门店商户号添加到分账接收方列表中。

  4. 服务商需确保向微信支付传输用户身份信息和账号标识信息做一致性校验已合法征得用户授权

接口说明

支持商户:【普通服务商】

请求方式:【POST】/v3/brand/profitsharing/receivers/add

请求域名:【主域名】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  包体参数

 brand_mchid  必填   string(32)

【品牌主商户号】 品牌主商户号即绑定具体品牌的商户号,填写微信支付分配的商户号


 appid  必填   string(32)

【公众账号ID】 微信分配的公众账号ID


 sub_appid  选填   string(32)

【子商户公众账号ID】 品牌主的公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填


 type  必填   string(32)

【接收方类型】 分账接收方类型,枚举值:

  1. MERCHANT_ID:商户号(mch_id或者sub_mch_id)

  2. PERSONAL_OPENID:个人OpenID(由服务商的AppID转换得到)

  3. PERSONAL_SUB_OPENID:个人OpenID(由品牌主的AppID转换得到)


 account  必填   string(64)

【接收方账号】 分账接收方账号

  1. 分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号(mch_id或者sub_mch_id)

  2. 分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人OpenID(由服务商的AppID转换得到)

  3. 分账接收方类型为PERSONAL_SUB_OPENID时,分账接收方账号为个人OpenID(由品牌主的AppID转换得到)


 name  选填   string(256)

【接收方名称】 分账接收方的名称。

  1. 当type为MERCHANT_ID时,接收方名称必传,且为商户全称。

  2. 当type为PERSONAL_OPENID时,接收方名称选传,且为个人姓名。(传入该字段时需要进行校验。)

  3. 当type为PERSONAL_SUB_OPENID时,接收方名称选传,且为个人姓名。(传入该字段时需要进行校验。)


 relation_type  必填   string(32)

【与品牌主的关系类型】 枚举值:

  • SUPPLIER:供应商 

  • DISTRIBUTOR:分销商 

  • SERVICE_PROVIDER:服务商 

  • PLATFORM:平台 

  • STAFF:员工 

  • OTHERS:其他

请求示例

Java
Go
curl

需配合微信支付工具库 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 AddReceiver {
26  private static String HOST = "https://api.mch.weixin.qq.com";
27  private static String METHOD = "POST";
28  private static String PATH = "/v3/brand/profitsharing/receivers/add";
29
30  public static void main(String[] args) {
31    // TODO: 请准备商户开发必要参数,参考:https://pay.weixin.qq.com/doc/v3/partner/4013080340
32    AddReceiver client = new AddReceiver(
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    AddReceiverRequest request = new AddReceiverRequest();
41    request.brandMchid = "1900000108";
42    request.appid = "wx8888888888888888";
43    request.subAppid = "wx8888888888888889";
44    request.type = "MERCHANT_ID";
45    request.account = "1900000109";
46    request.name = "示例商户全称";
47    request.relationType = "SUPPLIER";
48    try {
49      AddReceiverResponse response = client.run(request);
50
51      // TODO: 请求成功,继续业务逻辑
52      System.out.println(response);
53    } catch (WXPayUtility.ApiException e) {
54      // TODO: 请求失败,根据状态码执行不同的逻辑
55      e.printStackTrace();
56    }
57  }
58
59  public AddReceiverResponse run(AddReceiverRequest request) {
60    String uri = PATH;
61    String reqBody = WXPayUtility.toJson(request);
62
63    Request.Builder reqBuilder = new Request.Builder().url(HOST + uri);
64    reqBuilder.addHeader("Accept", "application/json");
65    reqBuilder.addHeader("Wechatpay-Serial", wechatPayPublicKeyId);
66    reqBuilder.addHeader("Authorization", WXPayUtility.buildAuthorization(mchid, certificateSerialNo,privateKey, METHOD, uri, reqBody));
67    reqBuilder.addHeader("Content-Type", "application/json");
68    RequestBody requestBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), reqBody);
69    reqBuilder.method(METHOD, requestBody);
70    Request httpRequest = reqBuilder.build();
71
72    // 发送HTTP请求
73    OkHttpClient client = new OkHttpClient.Builder().build();
74    try (Response httpResponse = client.newCall(httpRequest).execute()) {
75      String respBody = WXPayUtility.extractBody(httpResponse);
76      if (httpResponse.code() >= 200 && httpResponse.code() < 300) {
77        // 2XX 成功,验证应答签名
78        WXPayUtility.validateResponse(this.wechatPayPublicKeyId, this.wechatPayPublicKey,
79            httpResponse.headers(), respBody);
80
81        // 从HTTP应答报文构建返回数据
82        return WXPayUtility.fromJson(respBody, AddReceiverResponse.class);
83      } else {
84        throw new WXPayUtility.ApiException(httpResponse.code(), respBody, httpResponse.headers());
85      }
86    } catch (IOException e) {
87      throw new UncheckedIOException("Sending request to " + uri + " failed.", e);
88    }
89  }
90
91  private final String mchid;
92  private final String certificateSerialNo;
93  private final PrivateKey privateKey;
94  private final String wechatPayPublicKeyId;
95  private final PublicKey wechatPayPublicKey;
96
97  public AddReceiver(String mchid, String certificateSerialNo, String privateKeyFilePath, String wechatPayPublicKeyId, String wechatPayPublicKeyFilePath) {
98    this.mchid = mchid;
99    this.certificateSerialNo = certificateSerialNo;
100    this.privateKey = WXPayUtility.loadPrivateKeyFromPath(privateKeyFilePath);
101    this.wechatPayPublicKeyId = wechatPayPublicKeyId;
102    this.wechatPayPublicKey = WXPayUtility.loadPublicKeyFromPath(wechatPayPublicKeyFilePath);
103  }
104
105  public static class AddReceiverRequest {
106    @SerializedName("brand_mchid")
107    public String brandMchid;
108  
109    @SerializedName("appid")
110    public String appid;
111  
112    @SerializedName("sub_appid")
113    public String subAppid;
114  
115    @SerializedName("type")
116    public String type;
117  
118    @SerializedName("account")
119    public String account;
120  
121    @SerializedName("name")
122    public String name;
123  
124    @SerializedName("relation_type")
125    public String relationType;
126  }
127  
128  public static class AddReceiverResponse {
129    @SerializedName("brand_mchid")
130    public String brandMchid;
131  
132    @SerializedName("type")
133    public String type;
134  
135    @SerializedName("account")
136    public String account;
137  }
138  
139}
140

应答参数

200 OK

 brand_mchid  必填   string(32)

【品牌主商户号】 品牌主商户号,即绑定具体品牌的商户号,填写微信支付分配的商户号。


 type  必填   string(32)

【接收方类型】 分账接收方类型,枚举值:

  1. MERCHANT_ID:商户号(mch_id或者sub_mch_id)

  2. PERSONAL_OPENID:个人OpenID(由服务商的AppID转换得到)

  3. PERSONAL_SUB_OPENID:个人OpenID(由品牌主的AppID转换得到)


 account  必填   string(64)

【接收方账号】 分账接收方账号

  1. 分账接收方类型为MERCHANT_ID时,分账接收方账号为商户号(mch_id或者sub_mch_id)

  2. 分账接收方类型为PERSONAL_OPENID时,分账接收方账号为个人OpenID(由服务商的AppID转换得到)

  3. 分账接收方类型为PERSONAL_SUB_OPENID时,分账接收方账号为个人OpenID(由品牌主的AppID转换得到)

应答示例

200 OK

1{
2  "brand_mchid" : "1900000108",
3  "type" : "MERCHANT_ID",
4  "account" : "1900000109"
5}
6

 

错误码

公共错误码

状态码

错误码

描述

解决方案

400

PARAM_ERROR

参数错误

请根据错误提示正确传入参数

400

INVALID_REQUEST

HTTP 请求不符合微信支付 APIv3 接口规则

请参阅 接口规则

401

SIGN_ERROR

验证不通过

请参阅 签名常见问题

500

SYSTEM_ERROR

系统异常,请稍后重试

请稍后重试

 

 

更多技术问题
技术咨询
反馈
咨询
目录
置顶