# 查询商户余额

> 本文档描述服务器端接收的消息或事件，详细说明参见[消息推送](/miniprogram/dev/framework/server-ability/message-push.md)。

事件英文名：logistics.onGetQuota

查询商户余额事件

## 1. 消息参数

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "ToUserName",
    "类型": "string",
    "说明": "快递公司小程序 UserName"
  },
  {
    "参数名": "FromUserName",
    "类型": "string",
    "说明": "微信团队的 OpenID （固定值）"
  },
  {
    "参数名": "CreateTime",
    "类型": "number",
    "说明": "事件时间，Unix时间戳"
  },
  {
    "参数名": "MsgType",
    "类型": "string",
    "说明": "消息类型，固定为 event"
  },
  {
    "参数名": "Event",
    "类型": "string",
    "说明": "事件类型，固定为 get_quota，不区分大小写"
  },
  {
    "参数名": "BizID",
    "类型": "string",
    "说明": "商户ID，即商户在快递注册的客户编码或月结账户名"
  },
  {
    "参数名": "BizPwd",
    "类型": "string",
    "说明": "BizID 对应的密码"
  },
  {
    "参数名": "ShopAppID",
    "类型": "string",
    "说明": "商户小程序的 AppID"
  }
]
```

## 2. 消息返回

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "ToUserName",
    "类型": "string",
    "必填": "是",
    "说明": "原样返回请求中的 FromUserName",
    "枚举": "-"
  },
  {
    "参数名": "FromUserName",
    "类型": "string",
    "必填": "是",
    "说明": "快递公司小程序 UserName",
    "枚举": "-"
  },
  {
    "参数名": "CreateTime",
    "类型": "number",
    "必填": "是",
    "说明": "事件时间，Unix时间戳",
    "枚举": "-"
  },
  {
    "参数名": "MsgType",
    "类型": "string",
    "必填": "是",
    "说明": "消息类型，固定为event",
    "枚举": "-"
  },
  {
    "参数名": "Event",
    "类型": "string",
    "必填": "是",
    "说明": "事件类型，固定为get_quota，不区分大小写",
    "枚举": "-"
  },
  {
    "参数名": "BizID",
    "类型": "string",
    "必填": "是",
    "说明": "商户ID",
    "枚举": "-"
  },
  {
    "参数名": "ResultCode",
    "类型": "number",
    "必填": "是",
    "说明": "处理结果错误码",
    "枚举": "枚举值"
  },
  {
    "参数名": "ResultMsg",
    "类型": "string",
    "必填": "是",
    "说明": "处理结果详情",
    "枚举": "-"
  },
  {
    "参数名": "Quota",
    "类型": "number",
    "必填": "是",
    "说明": "商户可用余额，0 表示无可用余额",
    "枚举": "-"
  }
]
```

## 3. 枚举信息

### Res.ResultCode `Enum`

处理结果错误码

```json
[
  {
    "枚举值": "0",
    "描述": "查询成功"
  },
  {
    "枚举值": "-1",
    "描述": "其他错误"
  },
  {
    "枚举值": "10001",
    "描述": "客户编码或者月结账户不存在"
  },
  {
    "枚举值": "10002",
    "描述": "客户密码不正确"
  }
]
```

## 4. 注意事项

本事件无特殊注意事项

## 5. 代码示例

### 5.1 XML 格式

请求示例

```xml
<xml>
    <ToUserName><![CDATA[gh_abcdefg]]></ToUserName>
    <FromUserName><![CDATA[oABCD]]></FromUserName>
    <CreateTime>1533042556</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[get_quota]]></Event>
    <BizID><![CDATA[xyz]]></BizID>
    <BizPwd><![CDATA[xyz123]]></BizPwd>
    <ShopAppID><![CDATA[wxABCD]]></ShopAppID>
</xml>
```

返回示例

```xml
<xml>
    <ToUserName><![CDATA[oABCD]]></ToUserName>
    <FromUserName><![CDATA[gh_abcdefg]]></FromUserName>
    <CreateTime>1533042556</CreateTime>
    <MsgType><![CDATA[event]]></MsgType>
    <Event><![CDATA[get_quota]]></Event>
    <BizID><![CDATA[xyz]]></BizID>
    <ResultCode>0</ResultCode>
    <ResultMsg><![CDATA[success]]></ResultMsg>
    <Quota>0</Quota>
</xml>
```

### 5.2 JSON 格式

请求示例

```json
{
  "ToUserName": "gh_abcdefg",
  "FromUserName": "oABCD",
  "CreateTime": 1533042556,
  "MsgType": "event",
  "Event": "get_quota",
  "BizID": "xyz",
  "BizPwd": "xyz123",
  "ShopAppID": "wxABCD"
}
```

返回示例

```json
{
  "ToUserName": "oABCD",
  "FromUserName": "gh_abcdefg",
  "CreateTime": 1533042556,
  "MsgType": "event",
  "Event": "get_quota",
  "BizID": "xyz",
  "ResultCode": 0,
  "ResultMsg": "success",
  "Quota": 0
}
```