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

# Consultar Saldo

> Retorna o saldo disponível e pendente da conta

## Descrição

Retorna o saldo disponível para saque e o saldo pendente (cobranças pagas ainda não liberadas).

***

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer token de autenticação. Formato: `Bearer sk_live_xxx`
</ParamField>

***

## Exemplo de Requisição

<CodeGroup>
  ```bash cURL theme={null}
  curl https://api.flarepayments.com/v1/balance \
    -H "Authorization: Bearer sk_live_sua_chave_aqui"
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.flarepayments.com/v1/balance', {
    headers: {
      'Authorization': 'Bearer sk_live_sua_chave_aqui'
    }
  });
  const balance = await response.json();
  console.log(`Disponível: R$ ${balance.summary.available_balance}`);
  ```

  ```python Python theme={null}
  import requests

  balance = requests.get(
      'https://api.flarepayments.com/v1/balance',
      headers={'Authorization': 'Bearer sk_live_sua_chave_aqui'}
  ).json()

  print(f"Disponível: R$ {balance['summary']['available_balance']}")
  ```
</CodeGroup>

***

## Resposta `200 OK`

<ResponseField name="object" type="string">
  Sempre `"balance"`
</ResponseField>

<ResponseField name="available" type="array">
  Saldo disponível por moeda

  <Expandable title="Propriedades">
    <ResponseField name="available[].amount" type="integer">
      Saldo disponível em <strong>centavos</strong>
    </ResponseField>

    <ResponseField name="available[].currency" type="string">
      Moeda (`brl`)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="pending" type="array">
  Saldo pendente por moeda

  <Expandable title="Propriedades">
    <ResponseField name="pending[].amount" type="integer">
      Saldo pendente em <strong>centavos</strong>
    </ResponseField>

    <ResponseField name="pending[].currency" type="string">
      Moeda (`brl`)
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="summary" type="object">
  Resumo em Reais

  <Expandable title="Propriedades">
    <ResponseField name="summary.available_balance" type="float">
      Saldo disponível em Reais
    </ResponseField>

    <ResponseField name="summary.pending_balance" type="float">
      Saldo pendente em Reais
    </ResponseField>

    <ResponseField name="summary.total_earned" type="float">
      Total recebido historicamente
    </ResponseField>

    <ResponseField name="summary.total_withdrawn" type="float">
      Total sacado historicamente
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  {
    "object": "balance",
    "available": [
      { "amount": 150000, "currency": "brl" }
    ],
    "pending": [
      { "amount": 25000, "currency": "brl" }
    ],
    "summary": {
      "available_balance": 1500.00,
      "pending_balance": 250.00,
      "total_earned": 5000.00,
      "total_withdrawn": 3250.00,
      "currency": "BRL"
    },
    "livemode": true
  }
  ```
</ResponseExample>

***

## Cálculo do Saldo Disponível

```
disponível = 
  soma(net_amount de cobranças pagas)
  - soma(amount de saques concluídos)
  - soma(amount de saques em processamento)
```

<Note>
  O `available_balance` já considera as taxas descontadas (`net_amount`) e os saques já solicitados.
</Note>