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

# Consultar saldo

> Retorna o saldo atual da conta. Exige o escopo `balance:read`.

<Note>
  Exige uma chave de API com o escopo `balance:read`. Para o extrato contábil completo (cada entrada de crédito e débito), veja "Extrato completo" logo abaixo.
</Note>

## Extrato completo

Para o histórico detalhado, use a sua sessão do painel (login) em vez da chave de API:

```bash theme={null}
curl https://api.zynpay.com.br/v1/ledger/statement \
  -H "Authorization: Bearer <accessToken-da-sessao>"
```

<Note>
  O extrato completo (`/v1/ledger/statement`) e o resumo do painel (`/v1/dashboard/summary`) exigem login de sessão — não estão disponíveis para chaves de API, que são pensadas para automação de cobrança, não para acesso administrativo à conta.
</Note>


## OpenAPI

````yaml GET /v1/public/pix/balance
openapi: 3.1.0
info:
  title: ZynPay Public API
  version: '1.0'
  description: >
    API pública da ZynPay para gerar cobranças Pix e consultar saldo com uma
    chave de API.

    Todo valor monetário é um inteiro em centavos (R$ 10,00 = `1000`).
  license:
    name: Proprietary
servers:
  - url: https://api.zynpay.com.br
security:
  - apiKeyAuth: []
tags:
  - name: Cobranças
    description: Criar e consultar cobranças Pix
  - name: Saldo
    description: Consultar o saldo da conta
paths:
  /v1/public/pix/balance:
    get:
      tags:
        - Saldo
      summary: Consultar saldo
      description: Retorna o saldo atual da conta. Exige o escopo `balance:read`.
      operationId: getBalance
      responses:
        '200':
          description: Saldo da conta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    Balance:
      type: object
      required:
        - currency
        - availableCents
        - reservedCents
        - blockedCents
      properties:
        currency:
          type: string
          const: BRL
        availableCents:
          type: integer
          description: Saldo livre para saque.
        reservedCents:
          type: integer
          description: Valor reservado por saques em análise.
        blockedCents:
          type: integer
          description: Valor bloqueado pela equipe da ZynPay.
    ErrorEnvelope:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - requestId
          properties:
            code:
              type: string
              example: ACCOUNT_NOT_VERIFIED
            message:
              type: string
            fields:
              type: object
              additionalProperties:
                type: array
                items:
                  type: string
            requestId:
              type: string
  responses:
    Unauthorized:
      description: Chave de API ausente, inválida, revogada ou expirada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Forbidden:
      description: Conta não verificada, ou a chave não tem o escopo necessário
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: zpk_live_...
      description: Chave de API criada em Integrações → Chaves de API no painel.

````