Avistadocs

Consultar saldo da conta

GET /api/balance

GET https://api.avista.global/api/balance

Requer 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
curl -X GET "https://api.avista.global/api/balance" \
  -H "Authorization: Bearer $AVISTA_TOKEN"
const axios = require('axios');

const response = await axios.get('https://api.avista.global/api/balance', {
  headers: { 'Authorization': `Bearer ${process.env.AVISTA_TOKEN}` },
});
console.log(response.data);
import os, requests

response = requests.get(
    'https://api.avista.global/api/balance',
    headers={'Authorization': f'Bearer {os.environ["AVISTA_TOKEN"]}'},
)
print(response.json())
$ch = curl_init('https://api.avista.global/api/balance');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('AVISTA_TOKEN'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.avista.global/api/balance"))
    .header("Authorization", "Bearer " + System.getenv("AVISTA_TOKEN"))
    .GET()
    .build();
HttpResponse<String> response = HttpClient.newHttpClient()
    .send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Response (200)

CampoTipoDescrição
grossBalancenumberSaldo bruto (total disponível + bloqueado)
blockedBalancenumberSaldo bloqueado (reservado para operações pendentes)
netBalancenumberSaldo líquido (disponível para uso)
consultedAtstringData e hora da consulta (ISO 8601)
{
  "grossBalance": 48734.90,
  "blockedBalance": 0,
  "netBalance": 48734.90,
  "consultedAt": "2025-11-19T20:18:29.384Z"
}

Erros

StatusDescrição
401Token inválido, expirado ou não fornecido

Nesta página