Consulta de Saldo

Visão Geral

O endpoint de Consulta de Saldo permite verificar o saldo atual disponível na sua conta. Este endpoint retorna o saldo em tempo real, calculado com base em todas as transações realizadas.

Autenticação

Antes de fazer requisições, você precisa obter um token de acesso OAuth 2.0. Consulte a documentação de autenticação para mais detalhes.

Authorization: Bearer <seu-access-token>
Content-Type: application/json

Requisição

O header Authorization deve conter o token de acesso obtido através do endpoint de autenticação OAuth, no formato Bearer Token.

Resposta

{
  "balance": 1250.75
}

Exemplo de Requisição

Abaixo está um exemplo de como fazer a requisição usando cURL:

curl -X GET https://api.vexapagamentos.com.br/api/v1/balance \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json"

E um exemplo usando JavaScript (fetch):

const response = await fetch('https://api.vexapagamentos.com.br/api/v1/balance', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
// Saldo disponível em data.balance

Possíveis Erros

{
    "message": "Unauthorized",
    "statusCode": 401
}

{
    "message": "Usuário não encontrado ou inativo",
    "error": "Forbidden",
    "statusCode": 403
}

{
    "message": "Credencial não encontrada",
    "error": "Not Found",
    "statusCode": 404
}

Notas Importantes