Skip to main content
GET
/
api
/
v1
/
user
/
balance
curl -X GET 'https://api.visionwallet.com.br/api/v1/user/balance' \
  -H 'X-API-Key: sua_api_key'
{
  "success": true,
  "data": {
    "balance": {
      "total": 50000,
      "pendingPayments": 10000,
      "totalWithPending": 60000,
      "isNegative": false
    },
    "disputes": {
      "total": 0,
      "pending": 0,
      "totalDisputedAmount": 0,
      "totalBlockedAmount": 0
    },
    "statistics": {
      "totalReceived": 200000,
      "totalFees": 1000,
      "completedPayments": 20,
      "pendingPayments": 2,
      "totalPayments": 22
    },
    "limits": {
      "daily": 1000000,
      "dailyUsed": 50000,
      "dailyRemaining": 950000,
      "monthly": 10000000,
      "monthlyUsed": 200000,
      "monthlyRemaining": 9800000,
      "perTransaction": 100000
    },
    "plan": {
      "name": "PRO",
      "transactionFee": 50,
      "transactionFeeInReais": "0.50"
    }
  }
}

Consultar Saldo

Obtenha informações detalhadas sobre saldo, estatísticas e limites.
curl -X GET 'https://api.visionwallet.com.br/api/v1/user/balance' \
  -H 'X-API-Key: sua_api_key'
{
  "success": true,
  "data": {
    "balance": {
      "total": 50000,
      "pendingPayments": 10000,
      "totalWithPending": 60000,
      "isNegative": false
    },
    "disputes": {
      "total": 0,
      "pending": 0,
      "totalDisputedAmount": 0,
      "totalBlockedAmount": 0
    },
    "statistics": {
      "totalReceived": 200000,
      "totalFees": 1000,
      "completedPayments": 20,
      "pendingPayments": 2,
      "totalPayments": 22
    },
    "limits": {
      "daily": 1000000,
      "dailyUsed": 50000,
      "dailyRemaining": 950000,
      "monthly": 10000000,
      "monthlyUsed": 200000,
      "monthlyRemaining": 9800000,
      "perTransaction": 100000
    },
    "plan": {
      "name": "PRO",
      "transactionFee": 50,
      "transactionFeeInReais": "0.50"
    }
  }
}

Parâmetros

Campos da Resposta

balance
object
Informações sobre o saldo da conta.
statistics
object
Estatísticas de transações do usuário.
limits
object
Limites de transação configurados para o usuário.

Permissões Necessárias

Esta rota requer a permissão read:balance.

Rate Limiting

  • 10 req/s (600 req/min) por API Key
Esta rota possui cache variável para melhorar a performance.

Authorizations

X-API-Key
string
header
required

API Key para autenticação. Use o header X-API-Key ou Authorization: Bearer {api_key}

Response

200 - application/json

Informações de saldo

success
boolean
data
object