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

# Consultar Saldo

> Obtenha informações detalhadas sobre saldo, estatísticas e limites

Obtenha informações detalhadas sobre saldo, estatísticas e limites.

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.eyowallet.ru/api/v1/user/balance' \
    -H 'X-API-Key: sua_api_key'
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "success": true,
    "data": {
      "balance": {
        "total": 50000,
        "pendingPayments": 10000,
        "totalWithPending": 60000,
        "isNegative": false
      },
      "disputes": {
        "total": 0,
        "pending": 0,
        "totalDisputedAmount": 0,
        "totalBlockedAmount": 0
      },
      "statistics": {
        "totalReceived": 200000,
        "totalFees": 1000,
        "completedPayments": 20,
        "pendingPayments": 2,
        "totalPayments": 22
      },
      "limits": {
        "daily": 1000000,
        "dailyUsed": 50000,
        "dailyRemaining": 950000,
        "monthly": 10000000,
        "monthlyUsed": 200000,
        "monthlyRemaining": 9800000,
        "perTransaction": 100000
      },
      "plan": {
        "name": "PRO",
        "transactionFee": 50,
        "transactionFeeInReais": "0.50"
      }
    }
  }
  ```
</ResponseExample>

### Parâmetros

### Campos da Resposta

<ResponseField name="balance" type="object">
  Informações sobre o saldo da conta.

  <Expandable title="Propriedades do saldo">
    <ResponseField name="total" type="integer">
      Saldo atual em centavos (ex: 50000 = R\$ 500,00).
    </ResponseField>

    <ResponseField name="pendingPayments" type="integer">
      Valor total de pagamentos pendentes em centavos.
    </ResponseField>

    <ResponseField name="totalWithPending" type="integer">
      Saldo total incluindo pagamentos pendentes.
    </ResponseField>

    <ResponseField name="isNegative" type="boolean">
      Indica se o saldo está negativo.
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="statistics" type="object">
  Estatísticas de transações do usuário.
</ResponseField>

<ResponseField name="limits" type="object">
  Limites de transação configurados para o usuário.
</ResponseField>

### Permissões Necessárias

Esta rota requer a permissão `read:balance`.

### Rate Limiting

* **10 req/s (600 req/min) por API Key**

<Note>
  Esta rota possui cache variável para melhorar a performance.
</Note>


## OpenAPI

````yaml GET /api/v1/user/balance
openapi: 3.1.0
info:
  title: Eyo Wallet API
  description: >-
    API para integração com a Eyo Wallet - Plataforma de pagamentos PIX para
    desenvolvedores e empresas
  version: 1.0.0
  contact:
    name: Eyo Wallet
    url: https://eyowallet.ru
servers:
  - url: https://api.eyowallet.ru
    description: Servidor de Produção
security:
  - apiKeyAuth: []
tags:
  - name: Payments
    description: Endpoints para criar e gerenciar pagamentos PIX
  - name: Withdraws
    description: Endpoints para criar e gerenciar saques via PIX
  - name: Transfers
    description: Endpoints para transferências internas entre contas Eyo Wallet
  - name: User
    description: Endpoints para informações do usuário e configurações
paths:
  /api/v1/user/balance:
    get:
      tags:
        - User
      summary: Consultar Saldo
      description: >-
        Obtém informações detalhadas sobre saldo, estatísticas e limites da
        conta
      operationId: getBalance
      responses:
        '200':
          description: Informações do saldo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BalanceResponse'
components:
  schemas:
    BalanceResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: object
          properties:
            balance:
              type: object
              properties:
                total:
                  type: integer
                  description: Saldo atual em centavos
                pendingPayments:
                  type: integer
                  description: Valor total de pagamentos pendentes em centavos
                totalWithPending:
                  type: integer
                  description: Saldo total incluindo pagamentos pendentes
                isNegative:
                  type: boolean
                  description: Indica se o saldo está negativo
            disputes:
              type: object
              properties:
                total:
                  type: integer
                pending:
                  type: integer
                totalDisputedAmount:
                  type: integer
                totalBlockedAmount:
                  type: integer
            statistics:
              type: object
              properties:
                totalReceived:
                  type: integer
                  description: Total recebido em centavos
                totalFees:
                  type: integer
                  description: Total de taxas pagas em centavos
                completedPayments:
                  type: integer
                pendingPayments:
                  type: integer
                totalPayments:
                  type: integer
            limits:
              type: object
              properties:
                daily:
                  type: integer
                  description: Limite diário em centavos
                dailyUsed:
                  type: integer
                dailyRemaining:
                  type: integer
                monthly:
                  type: integer
                  description: Limite mensal em centavos
                monthlyUsed:
                  type: integer
                monthlyRemaining:
                  type: integer
                perTransaction:
                  type: integer
                  description: Limite por transação em centavos
            plan:
              type: object
              properties:
                name:
                  type: string
                transactionFee:
                  type: integer
                  description: Taxa por transação em centavos
                transactionFeeInReais:
                  type: string
                  description: Taxa por transação em reais
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API Key obtida no painel da Eyo Wallet

````