# 查询分账方
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:queryprofitsharingaccount
通过 api 方式查询分账方
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/retail/B2b/queryprofitsharingaccount?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
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| offset | number | 否 | 分账方数据起始位置的偏移量,默认值为0 |
| limit | number | 否 | 返回分账方数据的最大条数,默认值为10 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | - |
| errmsg | string | - |
| account_list | objarray | 包含多个RetailProfitSharingAccountInfo对象 |
# Res.account_list(Array) Object Payload
包含多个RetailProfitSharingAccountInfo对象
| 参数名 | 类型 | 说明 |
|---|---|---|
| sharing_account_type | string | 枚举值:"PAYEE_TYPE_EXTERNAL_USER" - 外部用户;"PAYEE_TYPE_EXTERNAL_MERCHANT" - 外部商户;(与添加分账方 API 中的 payee_type 对应) |
| sharing_account | string | 类型为外部用户时,表示个人 openid;类型为外部商户时,表示商户号;(与添加分账方 API 中的 payee_id 对应) |
| add_time | number | - |
| update_time | number | - |
| name | string | 类型为外部商户时,返回对应的商户名称 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
{
"offset": 0,
"limit": 1000
}
返回示例
{
"account_list": [{
"sharing_account_type": "PAYEE_TYPE_EXTERNAL_MERCHANT",
"sharing_account": "1234567890",
"add_time": 1724222992,
"update_time": 1724222992,
"name": "XXX公司"
}],
"errcode": 0,
"errmsg": "OK"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| 1 | 查询不到可用分账方 |
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。