> ## Documentation Index
> Fetch the complete documentation index at: https://docs.velfy.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Consultar saldo

> Como consultar o saldo disponível, valores presos e antecipações da sua conta

# Consultar Saldo

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

## 🛠️ Endpoint

```text theme={null}
GET /api/v1/balance
```

Autenticado via [Basic Auth](/api-reference/payments/authentication) com sua secret key e public key.

### Exemplo

```bash theme={null}
curl -X GET 'https://api.velfy.com/api/v1/balance' \
  -u "sk_xxx:pk_xxx"
```

## 📥 Corpo da Resposta

```json theme={null}
{
  "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                                                         |

<Info>
  O `available` já considera saques em andamento — é o valor real que você pode solicitar em um novo [saque (PIX Out)](/api-reference/payments/withdraw).
</Info>

***

## 🎯 Próximos Passos

<CardGroup cols={2}>
  <Card title="💸 Solicitar Saque" color="#631286" icon="money-bill-transfer" href="/api-reference/payments/withdraw">
    Envie uma transferência PIX para fora da sua conta
  </Card>

  <Card title="📝 Criando Transações" color="#631286" icon="rectangle-list" href="/api-reference/payments/transactions">
    Veja como criar novas cobranças
  </Card>
</CardGroup>