# 查询分账剩余金额

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：queryProfitSharingRemainamt

可用于查询某笔支付单分账完剩余金额。

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/retail/B2b/queryprofitsharingremainamt?access_token=ACCESS_TOKEN&pay_sig=pay_sig
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

- 该接口所属的权限集 id 为：158

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  },
  {
    "参数名": "pay_sig",
    "类型": "string",
    "必填": "是",
    "示例": "pay_sig",
    "说明": "支付签名"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "mchid",
    "类型": "string",
    "必填": "是",
    "说明": "子商户id。在B2b小程序中进件完成返回的子商户 id"
  },
  {
    "参数名": "out_trade_no",
    "类型": "string",
    "必填": "是",
    "说明": "订单 id。在B2b小程序中下单的订单 id"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "remain_amt",
    "类型": "number",
    "说明": "冻结金额，单位：分"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

请求示例

```json
{
  "out_trade_no": "4001289122107515929",
  "mchid": "16548451",
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "OK",
  "remain_amt": 98
}
```

## 6. 错误码

此接口没有特殊错误码，可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

## 7. 适用范围

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