Consultar saldo de la cuenta
GET /api/balance
GET https://<api-host>/api/balanceRequiere un Bearer token en el header Authorization. Vea Generar Token para obtener uno.
Retorna el saldo bruto, bloqueado y neto de la cuenta autenticada.
Autenticación
Requiere un Bearer token en el header Authorization.
Ejemplos 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);Respuesta (200)
| Campo | Tipo | Descripción |
|---|---|---|
grossBalance | number | Saldo bruto (total disponible + bloqueado) |
blockedBalance | number | Saldo bloqueado (reservado para operaciones pendientes) |
netBalance | number | Saldo neto (disponible para uso) |
consultedAt | string | Fecha y hora de la consulta (ISO 8601) |
{
"grossBalance": 48734.90,
"blockedBalance": 0,
"netBalance": 48734.90,
"consultedAt": "2025-11-19T20:18:29.384Z"
}Errores
| Estado | Descripción |
|---|---|
| 401 | Token inválido, expirado o faltante |