# 添加分账方
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:addProfitSharingAccount
可以通过 api 方式添加分账方,单个小程序添加的分账接收方上限为 1000。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/retail/B2b/addprofitsharingaccount?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用。
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:158
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 示例 | 说明 |
|---|---|---|---|---|
| access_token | string | 是 | ACCESS_TOKEN | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 | 枚举 |
|---|---|---|---|---|
| profit_sharing_relation_type | string | 是 | 分账接收方关系类型 | 枚举值 |
| payee_type | string | 是 | 分账接收方类型 | 枚举值 |
| payee_id | string | 是 | 分账接收方标识。 根据payee_type填入openid或商户号: 当payee_type="PAYEE_TYPE_EXTERNAL_USER"时填openid; 当payee_type="PAYEE_TYPE_EXTERNAL_MERCHANT"时填商户号 | - |
| payee_name | string | 否 | 分账接收方名称(分账接收方为商户号时必填)。 payee_type="PAYEE_TYPE_EXTERNAL_MERCHANT"时,填写商户名称 | - |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 示例 | 说明 |
|---|---|---|---|
| errcode | number | 0 | 错误码 |
| errmsg | string | ok | 错误信息 |
# 4. 枚举信息
# Body.profit_sharing_relation_type Enum
分账接收方关系类型
| 枚举值 | 描述 |
|---|---|
| RELATION_TYPE_SUPPLIER | 供应商 |
| RELATION_TYPE_DISTRIBUTOR | 分销商 |
| RELATION_TYPE_SERVICE_PROVIDER | 服务商 |
| RELATION_TYPE_PLATFORM | 平台 |
| RELATION_TYPE_OTHERS | 其他 |
# Body.payee_type Enum
分账接收方类型
| 枚举值 | 描述 |
|---|---|
| PAYEE_TYPE_EXTERNAL_USER | 外部用户 |
| PAYEE_TYPE_EXTERNAL_MERCHANT | 外部商户 |
# 5. 注意事项
pay_sig使用B2b商户号密钥生成即可。
# 6. 代码示例
请求示例
{
"profit_sharing_relation_type": "RELATION_TYPE_SERVICE_PROVIDER",
"payee_type": "PAYEE_TYPE_EXTERNAL_MERCHANT",
"payee_id": "1234567890",
"payee_name": "XXX公司"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 7. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 210001 | 添加分账方频繁 |
| 210002 | 添加分账方传入环境参数错误 |
| 210003 | 添加分账方传入账户类型错误 |
| 210004 | 重复添加分账方 |
| 210006 | 单个小程序绑定的分账方超过上限 |
# 8. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。