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

# Consultar Saldo

> Consulta o saldo disponível da carteira, liberado para saque e movimentações.

## Autenticação

Esta requisição requer autenticação via headers customizados:

<ParamField header="stpi" type="string" required>
  Seu Client ID.
</ParamField>

<ParamField header="stps" type="string" required>
  Seu Client Secret.
</ParamField>

## Resposta

<ResponseField name="statusCode" type="number">
  Código de status HTTP da requisição. Exemplo: `200`.
</ResponseField>

<ResponseField name="message" type="string">
  Mensagem descritiva da operação. Exemplo: `"Saldo consultado com sucesso."`.
</ResponseField>

<ResponseField name="data" type="object">
  Objeto contendo os dados do saldo disponível.

  <Expandable title="propriedades">
    <ResponseField name="available_cents" type="number">
      Saldo disponível para uso imediato ou saque, retornado **em centavos**.

      Exemplo: `120000` representa `R$ 1.200,00`.

      **Recomendação:** utilize este campo para cálculos financeiros e divida por `100` apenas para exibição no front-end.
    </ResponseField>

    <ResponseField name="currency" type="string">
      Moeda referente ao saldo da carteira. Padrão: `"BRL"`.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="timestamp" type="string">
  Data e hora da consulta no formato ISO 8601.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl --location 'https://api.stylepay.com.br/api/v1/wallet/balance' \
    --header 'stpi: seu_client_id' \
    --header 'stps: seu_client_secret'
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.stylepay.com.br/api/v1/wallet/balance', {
    method: 'GET',
    headers: {
      stpi: 'seu_client_id',
      stps: 'seu_client_secret'
    }
  });

  const json = await response.json();

  const saldoReais = json.data.available_cents / 100;

  console.log(`Saldo disponível: R$ ${saldoReais.toFixed(2)}`);
  ```

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

  url = "https://api.stylepay.com.br/api/v1/wallet/balance"

  headers = {
      "stpi": "seu_client_id",
      "stps": "seu_client_secret"
  }

  response = requests.get(url, headers=headers)
  data = response.json()

  saldo_reais = data["data"]["available_cents"] / 100

  print(f"Saldo disponível: R$ {saldo_reais:.2f}")
  ```

  ```php PHP theme={null}
  <?php

  $url = "https://api.stylepay.com.br/api/v1/wallet/balance";

  $headers = [
      "stpi: seu_client_id",
      "stps: seu_client_secret"
  ];

  $ch = curl_init($url);

  curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

  $response = curl_exec($ch);

  curl_close($ch);

  $json = json_decode($response, true);

  $saldo_reais = $json["data"]["available_cents"] / 100;

  echo "Saldo disponível: R$ " . number_format($saldo_reais, 2, ",", ".");

  ?>
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "statusCode": 200,
    "message": "Saldo consultado com sucesso.",
    "data": {
      "available_cents": 120000,
      "currency": "BRL"
    },
    "timestamp": "2026-05-05T00:12:45-03:00"
  }
  ```

  ```json 401 theme={null}
  {
    "statusCode": 401,
    "message": "Falha na autenticação."
  }
  ```

  ```json 500 theme={null}
  {
    "statusCode": 500,
    "message": "Erro interno."
  }
  ```
</ResponseExample>