# Saldo da conta

Consulte o saldo disponível, pendente e reservado da sua carteira.

GET`/account/balance`

Try it

## Autorização

[X-API-Key](#auth-X-API-Key)stringrequired

Chave VibeCash com permissão para esta operação.

## Resposta

200 application/json

[success](#response-success)booleanrequired

Indica se a operação foi concluída pela API.

[message](#response-message)stringrequired

Mensagem da operação.

[data](#response-data)objectrequired

Dados retornados pela operação.

Show child attributes[currency](#response-data-currency)string

Moeda BRL.

[availableAmount](#response-data-availableAmount)number

Saldo disponível em reais.

[pendingAmount](#response-data-pendingAmount)number

Valores de entradas pendentes.

[blockedAmount](#response-data-blockedAmount)number

Valores reservados para operações em confirmação.

[requestId](#response-requestId)string

Identificador da requisição.

## Erros

As falhas retornam o envelope com `success: false`. Consulte [erros e códigos HTTP](/docs/api-reference/guides/errors) para interpretar validação, permissão, conflito e saldo insuficiente.

## Exemplo de requisição

```bash
curl --request GET \
  --url 'https://seu-dominio/v1/account/balance' \
  --header 'X-API-Key: tp_live_SUA_CHAVE'
```

## Exemplo de resposta

```json
{
  "success": true,
  "message": "Operação concluída",
  "data": {
    "currency": "BRL",
    "availableAmount": 0,
    "pendingAmount": 0,
    "blockedAmount": 0,
    "status": "ACTIVE",
    "padrao": {
      "available": 0,
      "pending": 0,
      "withdrawable": 0
    }
  },
  "requestId": "req_exemplo"
}
```
