Consultar Saldo

Veja o saldo disponível e os valores retidos da sua conta Velfy

🛠️ Endpoint

GET /api/v1/balance

Autenticado via Basic Auth com sua secret key e public key.

Exemplo

curl -X GET 'https://api.velfy.com/api/v1/balance' \
  -u "sk_xxx:pk_xxx"

📥 Corpo da Resposta

{
  "success": true,
  "status": 200,
  "data": {
    "available": 152300,
    "waitingFunds": 48000,
    "lockedFunds": 0,
    "antecipation": 0,
    "withdraws": 30000
  }
}

Campo	Tipo	Descrição
`available`	`number`	Saldo disponível para saque, em centavos
`waitingFunds`	`number`	Valores a compensar/liberar (ex: boleto pendente, prazo de repasse), em centavos
`lockedFunds`	`number`	Valores bloqueados/retidos, em centavos
`antecipation`	`number \| null`	Valor antecipado, quando aplicável
`withdraws`	`number \| null`	Total já sacado da conta

O available já considera saques em andamento — é o valor real que você pode solicitar em um novo saque (PIX Out).

🎯 Próximos Passos

💸 Solicitar Saque

Envie uma transferência PIX para fora da sua conta

📝 Criando Transações

Veja como criar novas cobranças