# 获取小程序下所有商户的信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:getMchInfo
可以通过 api 方式获取某个小程序下所有商户的信息。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/retail/B2b/getmchinfo?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
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| mch_list | objarray | 商户列表 |
| total | number | 总数 |
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
# Res.mch_list(Array) Object Payload
商户列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| sub_mchid | string | string 商户号 注:有商户号不代表已开通成功,当 wxpay_status 值为 “完成” 才能使用。 string - string - string string string |
| company_name | string | 企业名称 |
| bank_name | string | 开户银行 |
| bank_account | string | 银行账号 脱敏处理,仅保留前两位和后两位,中间用 * 代替。 |
| wxpay_status | string | 微信支付开通状态。枚举: - 完成前平台额外准备 - 完成 |
| bank_transfer_status | string | 银行转账开通状态。枚举: - 未开通 - 开通中 - 开通成功 - 开通失败 - 申请驳回 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
请求示例
POST https://api.weixin.qq.com/retail/B2b/getmchinfo?access_token=ACCESS_TOKEN
返回示例
{
"mch_list": [
{
"sub_mchid": "111",
"company_name": "xx有限公司",
"bank_name": "xx银行",
"bank_account": "11***************11",
"wxpay_status": "完成",
"bank_transfer_status": "开通中"
}
],
"total": 1,
"errcode": 0,
"errmsg": "OK"
}
# 6. 错误码
此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
# 7. 适用范围
本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。