添加分账接收方API

更新时间:2023.08.16

商户发起添加分账接收方请求,建立分账接收方列表。后续可通过发起分账请求,将分账方商户结算后的资金,分到该分账接收方

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

# 接口说明

支持商户:
【普通服务商】
请求方式:
【POST】/v3/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
  • Wechatpay-Serial 必填 string
    【微信支付平台证书序列号】 请求参数中的敏感字段,需要使用微信支付平台证书公钥加密。请设置为该证书的证书序列号。详见敏感信息加解密
    Body 包体参数
  • sub_mchid 选填 string(32)
    【子商户号】 微信支付分配的子商户号,即分账的出资商户号。(直连商户不需要,服务商需要)
  • appid 必填 string(32)
    【公众账号ID】 微信分配的公众账号ID
  • sub_appid 选填 string(32)
    【子商户公众账号ID】 子商户的公众账号ID,分账接收方类型包含PERSONAL_SUB_OPENID时必填。(直连商户不需要,服务商需要)
  • type 必填 string
    【接收方类型】 枚举值:
    MERCHANT_ID:商户ID
    PERSONAL_OPENID:个人openid(由父商户APPID转换得到)
    PERSONAL_SUB_OPENID:个人sub_openid(由子商户APPID转换得到)
    可选取值:
    • MERCHANT_ID: 商户号
    • PERSONAL_OPENID: 个人OpenID(普通商户由直连商户AppID转换得到,服务商模式由服务商AppID转换得到)
    • PERSONAL_SUB_OPENID: 个人在子商户应用下的OpenID(由子商户AppID转换得到,直连商户不需要,仅服务商模式需要)
  • account 必填 string(64)
    【接收方账号】 类型是MERCHANT_ID时,是商户号
    类型是PERSONAL_OPENID时,是个人openid
    类型是PERSONAL_SUB_OPENID时,是个人sub_openid
  • name 选填 string(1024)
    【分账接收方全称】 分账接收方类型是MERCHANT_ID时,是商户全称(必传),当商户是小微商户或个体户时,是开户人姓名
    分账接收方类型是PERSONAL_OPENID时,是个人姓名(选传,传则校验)
    分账接收方类型是PERSONAL_SUB_OPENID时,是个人姓名(选传,传则校验)
    1、此字段需要加密,的加密方法详见:敏感信息加密说明
    2、使用微信支付平台证书中的公钥
    3、使用RSAES-OAEP算法进行加密
    4、将请求中HTTP头部的Wechatpay-Serial设置为证书序列号
  • relation_type 必填 string
    【与分账方的关系类型】 子商户与接收方的关系。
    本字段值为枚举:
    SERVICE_PROVIDER:服务商
    STORE:门店
    STAFF:员工
    STORE_OWNER:店主
    PARTNER:合作伙伴
    HEADQUARTER:总部
    BRAND:品牌方
    DISTRIBUTOR:分销商
    USER:用户
    SUPPLIER:供应商
    CUSTOM:自定义
    可选取值:
    • SERVICE_PROVIDER: 服务商
    • STORE: 门店
    • STAFF: 员工
    • STORE_OWNER: 店主
    • PARTNER: 合作伙伴
    • HEADQUARTER: 总部
    • BRAND: 品牌方
    • DISTRIBUTOR: 分销商
    • USER: 用户
    • SUPPLIER: 供应商
    • CUSTOM: 自定义
  • custom_relation 选填 string(10)
    【自定义的分账关系】 子商户与接收方具体的关系,本字段最多10个字。
    当字段relation_type的值为CUSTOM时,本字段必填
    当字段relation_type的值不为CUSTOM时,本字段无需填写

请求示例

POST

# 应答参数

    200OK
  • sub_mchid 选填 string(32)
    【子商户号】 参考请求参数
  • type 必填 string
    【接收方类型】 参考请求参数
    可选取值:
    • MERCHANT_ID: 商户号
    • PERSONAL_OPENID: 个人OpenID(普通商户由直连商户AppID转换得到,服务商模式由服务商AppID转换得到)
    • PERSONAL_SUB_OPENID: 个人在子商户应用下的OpenID(由子商户AppID转换得到,直连商户不需要,仅服务商模式需要)
  • account 必填 string(64)
    【接收方账号】 参考请求参数
  • name 选填 string(1024)
    【分账接收方全称】 参考请求参数。使用APIv3敏感信息加密方式
  • relation_type 必填 string
    【与分账方的关系类型】 参考请求参数
    可选取值:
    • SERVICE_PROVIDER: 服务商
    • STORE: 门店
    • STAFF: 员工
    • STORE_OWNER: 店主
    • PARTNER: 合作伙伴
    • HEADQUARTER: 总部
    • BRAND: 品牌方
    • DISTRIBUTOR: 分销商
    • USER: 用户
    • SUPPLIER: 供应商
    • CUSTOM: 自定义
  • custom_relation 选填 string(10)
    【自定义的分账关系】 参考请求参数

应答示例

200 OK

# 错误码

# 公共错误码

状态码 错误码 描述 解决方案
400 PARAM_ERROR 参数错误 请根据错误提示正确传入参数
400 INVALID_REQUEST HTTP 请求不符合微信支付 APIv3 接口规则 请参阅 接口规则
401 SIGN_ERROR 验证不通过 请参阅 签名常见问题
500 SYSTEM_ERROR 系统异常,请稍后重试 请稍后重试

# 业务错误码

状态码 错误码 描述 解决方案
400 INVALID_REQUEST 无效请求 请确认分账接收方是否存在
400 PARAM_ERROR 请求参数不符合参数格式 请使用正确的参数重新调用
403 NO_AUTH 商户无权限 请开通商户号分账权限
429 FREQUENCY_LIMITED 添加接收方频率过高 请降低频率后重试
500 SYSTEM_ERROR 系统错误 系统异常,请使用相同参数稍后重新调用
反馈
咨询
目录