# 查询账户余额

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:getMchBalance

查询B2b商户号下的余额

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/retail/B2b/getmchbalance?access_token=ACCESS_TOKEN

# 云调用

  • 本接口不支持云调用。

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:158

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String Parameters

参数名类型必填示例说明
access_tokenstringACCESS_TOKEN接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

参数名类型必填示例说明
mchidstring1230000109微信商户号。长度限制[1,32]。由微信支付生成并下发的商户号。

# 3. 返回参数

# 返回体 Response Payload

参数名类型示例说明
balance_listobjarray-账户资金。商户号的账户资金
errcodenumber0错误码
errmsgstringok错误信息

# Res.balance_list(Array) Object Payload

账户资金。商户号的账户资金

参数名类型示例说明枚举
balance_typestringBALANCE_TYPE_AVAILABLE资金类型。枚举值
amountstring0.00金额值。单位为元-
currencystringCNY货币类型-

# 4. 枚举信息

# Res.balance_list(Array).balance_type Enum

资金类型。

枚举值描述
BALANCE_TYPE_AVAILABLE可提现金额
BALANCE_TYPE_FROZEN待结算金额

# 5. 注意事项

本接口无特殊注意事项

# 6. 代码示例

请求示例

{
    "mchid": "1230000109"
}

返回示例

{
  "balance_list": [
    {
      "balance_type": "BALANCE_TYPE_AVAILABLE",
      "amount": "0.00",
      "currency": "CNY"
    },
    {
      "balance_type": "BALANCE_TYPE_FROZEN",
      "amount": "0.00",
      "currency": "CNY"
    }
  ],
  "errcode": 0,
  "errmsg": "OK"
}

# 7. 错误码

此接口没有特殊错误码,可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。

# 8. 适用范围

本接口暂未明确可调用账号类型,或在业务中根据调用传参自行确定是否可调用,请以实际调用情况为准。