Endpoints
Consultar Saldo
Visão Geral
O endpoint GET /api/accounts/balances retorna o saldo da conta autenticada no formato { data: [...] }, compatível com integrações que seguem o padrão do Banco Central.
Endpoint
GET https://<api-host>/api/accounts/balancesAutenticação
Token Bearer obtido em POST https://<api-host>/api/auth/token. Esta rota não usa certificado de cliente.
Parâmetros de query são aceitos por compatibilidade, mas ignorados: a resposta é sempre o saldo atual da conta do token.
Request
curl -X GET https://<api-host>/api/accounts/balances \
-H "Authorization: Bearer <token>"const response = await fetch('https://<api-host>/api/accounts/balances', {
method: 'GET',
headers: {
'Authorization': `Bearer ${token}`,
},
});
const balance = await response.json();import requests
response = requests.get(
'https://<api-host>/api/accounts/balances',
headers={
'Authorization': f'Bearer {token}',
}
)
balance = response.json()Response
Campos da Resposta
dataarrayLista de saldos. Sempre contém um único item.
Cálculo do Saldo Total
saldoTotal = available + blockedComparação com a API Padrão
API Padrão (GET /api/balance) | API BACEN (GET /api/accounts/balances) |
|---|---|
grossBalance | available + blocked |
blockedBalance | blocked |
netBalance | available |
consultedAt | eventDate |
Exemplo de Equivalência
// API Padrão
{
"grossBalance": 50234.90,
"blockedBalance": 1500.00,
"netBalance": 48734.90,
"consultedAt": "2025-01-15T10:30:00.000Z"
}
// API BACEN (equivalente)
{
"data": [{
"eventDate": "2025-01-15T10:30:00.000Z",
"balanceAmount": {
"available": 48734.90,
"blocked": 1500.00,
"overdraft": 0
}
}]
}Boas Práticas
Erros Comuns
| Código HTTP | Causa | Solução |
|---|---|---|
| 401 | Header Authorization ausente | Inclua Authorization: Bearer <token> |
| 401 | Token inválido ou expirado | Gere um novo token em POST /api/auth/token |