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

# Consultar saldo

> Consulte o saldo da sua conta por período.

<Info>
  Essa rota utiliza os certificados e o Bearer Token de **Cash Out**.
</Info>

## Certificados

Esta rota usa autenticação mútua (mTLS). Envie o certificado de **Cash Out**, a chave e a senha na requisição:

<ParamField path="--cert" type="file" required>
  Certificado de Cash Out do cliente (`client.crt`).
</ParamField>

<ParamField path="--key" type="file" required>
  Chave privada do cliente (`client.key`).
</ParamField>

<ParamField path="--pass" type="string" required>
  Senha para descriptografar a chave `.key`, enviada por e-mail junto com os certificados.
</ParamField>

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer Token de Cash Out. Formato: `Bearer {access_token}`.
</ParamField>

## Query

<ParamField query="event_date_start" type="string" required>
  Início do período consultado, no formato ISO 8601. Exemplo: `2026-07-01T00:00:00Z`.
</ParamField>

<ParamField query="event_date_end" type="string" required>
  Fim do período consultado, no formato ISO 8601. Exemplo: `2026-07-31T23:59:59Z`.
</ParamField>

<ParamField query="page_offset" type="integer">
  Offset da página consultada (mínimo `1`).
</ParamField>

<ParamField query="page_limit" type="integer">
  Registros por página, de `1` a `100`. Padrão: `10`.
</ParamField>

<ParamField query="sort_by" type="string">
  Campo usado para ordenar os resultados. Valor aceito: `EVENT_DATE`.
</ParamField>

<ParamField query="sort_type" type="string">
  Direção da ordenação: `ASC` (crescente) ou `DESC` (decrescente).
</ParamField>

<ParamField query="cut_edge_type" type="string">
  Tipo de corte de borda do período: `BEGIN_OF_DAY` ou `END_OF_DAY`.
</ParamField>

## Resposta

<ResponseField name="data" type="array">
  Lista de saldos por data no período consultado.

  <Expandable title="data">
    <ResponseField name="eventDate" type="string">
      Data do saldo (`YYYY-MM-DD`).
    </ResponseField>

    <ResponseField name="balanceAmount" type="object">
      Detalhamento do saldo na data.

      <Expandable title="balanceAmount">
        <ResponseField name="currency" type="string">
          Moeda (ex.: `BRL`).
        </ResponseField>

        <ResponseField name="available" type="number">
          Saldo disponível.
        </ResponseField>

        <ResponseField name="blocked" type="number">
          Saldo bloqueado.
        </ResponseField>

        <ResponseField name="overdraft" type="number">
          Limite de cheque especial utilizado.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://pagamentos.basspago.com.br/api/v2/accounts/balances?event_date_start=2026-07-01T00:00:00Z&event_date_end=2026-07-31T23:59:59Z" \
    --cert ./client.crt \
    --key ./client.key \
    --pass "SUA_SENHA_DO_CERTIFICADO" \
    -H "Authorization: Bearer {access_token}"
  ```

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

  $query = http_build_query([
      'event_date_start' => '2026-07-01T00:00:00Z',
      'event_date_end' => '2026-07-31T23:59:59Z',
  ]);

  $ch = curl_init("https://pagamentos.basspago.com.br/api/v2/accounts/balances?{$query}");

  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_SSLCERT => './client.crt',
      CURLOPT_SSLKEY => './client.key',
      CURLOPT_KEYPASSWD => 'SUA_SENHA_DO_CERTIFICADO',
      CURLOPT_HTTPHEADER => ['Authorization: Bearer {access_token}'],
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ```

  ```javascript Node.js theme={null}
  import fs from "node:fs";
  import https from "node:https";
  import axios from "axios";

  const agent = new https.Agent({
    cert: fs.readFileSync("./client.crt"),
    key: fs.readFileSync("./client.key"),
    passphrase: "SUA_SENHA_DO_CERTIFICADO",
  });

  const { data } = await axios.get(
    "https://pagamentos.basspago.com.br/api/v2/accounts/balances",
    {
      httpsAgent: agent,
      headers: { Authorization: "Bearer {access_token}" },
      params: {
        event_date_start: "2026-07-01T00:00:00Z",
        event_date_end: "2026-07-31T23:59:59Z",
      },
    }
  );

  console.log(data);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 - OK theme={null}
  {
    "data": [
      {
        "eventDate": "2026-07-21",
        "balanceAmount": {
          "currency": "BRL",
          "available": 84250.75,
          "blocked": 3200.00,
          "overdraft": 0.00
        }
      }
    ]
  }
  ```
</ResponseExample>