Query account balance
GET /api/balance
GET https://<api-host>/api/balanceRequires a Bearer token in the Authorization header. See Generate Token to obtain one.
Returns the gross, blocked, and net balance of the authenticated account.
Authentication
Requires a Bearer token in the Authorization header.
Code Examples
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);Response (200)
| Field | Type | Description |
|---|---|---|
grossBalance | number | Gross balance (total available + blocked) |
blockedBalance | number | Blocked balance (reserved for pending operations) |
netBalance | number | Net balance (available for use) |
consultedAt | string | Query date and time (ISO 8601) |
{
"grossBalance": 48734.90,
"blockedBalance": 0,
"netBalance": 48734.90,
"consultedAt": "2025-11-19T20:18:29.384Z"
}Errors
| Status | Description |
|---|---|
| 401 | Invalid, expired, or missing token |