查询账户余额
GET /api/balance
GET https://<api-host>/api/balance需要在 Authorization 头中提供 Bearer token。请参阅 生成令牌 获取。
返回已认证账户的总余额、冻结余额和净余额。
认证
需要在 Authorization 头中提供 Bearer 令牌。
代码示例
curl -X GET "https://<api-host>/api/balance" \
-H "Authorization: Bearer $PIX_API_TOKEN"const axios = require('axios');
const response = await axios.get('https://<api-host>/api/balance', {
headers: { 'Authorization': `Bearer ${process.env.PIX_API_TOKEN}` },
});
console.log(response.data);响应 (200)
| 字段 | 类型 | 描述 |
|---|---|---|
grossBalance | number | 总余额（可用金额 + 冻结金额） |
blockedBalance | number | 冻结余额（为待处理操作预留） |
netBalance | number | 净余额（可用金额） |
consultedAt | string | 查询日期和时间（ISO 8601） |
{
"grossBalance": 48734.90,
"blockedBalance": 0,
"netBalance": 48734.90,
"consultedAt": "2025-11-19T20:18:29.384Z"
}错误
| 状态码 | 描述 |
|---|---|
| 401 | 令牌无效、已过期或缺失 |