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

# Saldo

> GET /v2/balance — retorna o saldo atual da sua conta dividido por moeda e sub-conta.

## Campos do response

| Campo                          | Tipo   | Descrição                                                       |
| ------------------------------ | ------ | --------------------------------------------------------------- |
| `calculated_BRL_total_balance` | float  | Soma de todos os saldos convertidos para BRL pelas taxas atuais |
| `balances`                     | object | Agrupado por nome de moeda, depois por rede ou sub-conta        |

### Buckets de sub-conta

Cada entrada de moeda é dividida em quatro buckets:

| Campo        | Descrição                                                |
| ------------ | -------------------------------------------------------- |
| `available`  | Disponível para saque imediato                           |
| `in_transit` | Em trânsito enquanto uma transação está sendo processada |
| `to_receive` | Previsto para chegar de uma transação em andamento       |
| `blocked`    | Bloqueado para chargebacks ou retenções de conformidade  |

`calculated_BRL_balance` no nível da moeda é a soma em equivalente BRL de todas as sub-contas para aquela moeda.

<RequestExample>
  ```bash theme={null}
  curl https://checkout.noxpay.io/v2/balance \
    -H "api-key: <key>"
  ```

  ```python theme={null}
  import requests

  response = requests.get(
      "https://checkout.noxpay.io/v2/balance",
      headers={"api-key": "<key>"},
  )
  print(response.json())
  ```

  ```javascript theme={null}
  const response = await fetch("https://checkout.noxpay.io/v2/balance", {
    headers: { "api-key": "<key>" },
  });
  const data = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "calculated_BRL_total_balance": 1234.56,
    "balances": {
      "USDT": {
        "calculated_BRL_balance": 500.00,
        "USDT TRC20": {
          "calculated_BRL_balance": 500.00,
          "available": 100.00,
          "in_transit": 10.00,
          "to_receive": 5.00,
          "blocked": 0.00
        }
      },
      "BRL": {
        "calculated_BRL_balance": 734.56,
        "BRL": {
          "calculated_BRL_balance": 734.56,
          "available": 734.56,
          "in_transit": 0.00,
          "to_receive": 0.00,
          "blocked": 0.00
        }
      }
    }
  }
  ```
</ResponseExample>