账户余额查询
用于查询商户账户在各币种下的余额情况,一次返回全部已开账户的币种余额,支持按币种过滤。
请求说明
- 方法:
POST - 路径:
/api/v1/account/merchant/balanceQuery - Content-Type:
application/json - 鉴权:参考 接入准备 中参数以及签名算法说明,按照要求携带必须的鉴权信息
请求字段(Request Body)
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
currency | string | 否 | 币种代码(如 RUB),传入时只返回该币种余额;不传则返回全部币种 |
请求示例
json
{
"currency": "RUB"
}或查询全部币种:
json
{}响应参数
响应体为统一结构:result 表示请求结果,data 表示余额数据。
result 对象
| 字段 | 类型 | 说明 |
|---|---|---|
code | string | 返回码(成功/失败标识) |
msg | string | 返回信息说明 |
data 对象
| 字段 | 类型 | 必返 | 说明 |
|---|---|---|---|
balances | array | 是 | 币种级余额列表,见下表;无账户或过滤无结果时返回空数组 |
data.balances 对象
| 字段 | 类型 | 必返 | 说明 |
|---|---|---|---|
currency | string | 是 | 币种代码 |
availableBalance | string | 是 | 可用余额(字符串格式,保留 2 位小数,如 "1000.00") |
pendingBalance | string | 是 | 待结算余额(当前结算周内充值成功金额) |
frozenBalance | string | 是 | 冻结余额(出款处理中冻结的金额) |
响应示例
json
{
"result": {
"code": "S0000",
"msg": "Success"
},
"data": {
"balances": [
{
"currency": "RUB",
"availableBalance": "1000.00",
"pendingBalance": "500.00",
"frozenBalance": "200.00"
}
]
}
}说明
- 仅返回已开设渠道账户的币种;商户在某币种下没有任何渠道账户时,该币种不会出现在列表中
- 余额金额为字符串格式,固定保留 2 位小数,建议使用高精度十进制方式解析,避免浮点精度问题