余额查询
概述
此 API 用于查询商户账户的余额信息,包括账户总余额、冻结金额和可用余额。
提示
- 余额单位为分。
请求信息
- 请求方式:
POST - 请求路径:
/pay/mch/balance
请求参数
| 参数名称 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
| merchant_no | String | 是 | 商户号 |
响应参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| total_balance | Int | 是 | 账户总余额 |
| frozen_amount | Int | 是 | 冻结金额 |
| available_balance | Int | 是 | 可用余额 |
| settle_amount | Int | 否 | 待结算金额 |
提示
- 提现时,仅可提现可用余额
- 分账时,可用全部余额。
说明:
total_balance:账户总余额,包括可用余额和冻结金额。frozen_amount:冻结金额,暂时无法使用的金额。available_balance:可用余额,可用于支付的金额。settle_amount:待结算金额,需要在结算日进行结算的金额。- 单位为元。
成功响应示例
{
"total_balance": "1000",
"frozen_amount": "200",
"available_balance": "800"
}
错误响应示例
{
"code": 400101,
"message": "Invalid merchant_no"
}
错误码
| 错误码 | 描述 |
|---|---|
| 400101 | 请求参数错误 |
| 401001 | 未授权 |
| 404001 | 商户号未找到 |
| 500101 | 内部服务器错误 |