Consultar saldo da conta
GET /api/balance
GET https://<api-host>/api/balanceRequer um Bearer token no header Authorization. Veja Gerar Token para obter um.
Retorna o saldo bruto, bloqueado e líquido da conta autenticada.
Autenticação
Requer token Bearer no header Authorization.
Exemplos de Código
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)
| Campo | Tipo | Descrição |
|---|---|---|
grossBalance | number | Saldo bruto (total disponível + bloqueado) |
blockedBalance | number | Saldo bloqueado (reservado para operações pendentes) |
netBalance | number | Saldo líquido (disponível para uso) |
consultedAt | string | Data e hora da consulta (ISO 8601) |
{
"grossBalance": 48734.90,
"blockedBalance": 0,
"netBalance": 48734.90,
"consultedAt": "2025-11-19T20:18:29.384Z"
}Erros
| Status | Descrição |
|---|---|
| 401 | Token inválido, expirado ou não fornecido |