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

# Consultar saldo

> Retorna o saldo disponível para saque, limites configurados e o limite diário restante calculado em tempo real.



## OpenAPI

````yaml GET /withdrawals/balance
openapi: 3.1.0
info:
  title: Pluggou API
  description: API de intermediação de pagamentos da Pluggou
  version: 1.0.0
servers:
  - url: https://api.pluggoutech.com/api
security:
  - publicKey: []
    secretKey: []
paths:
  /withdrawals/balance:
    get:
      tags:
        - Transferências
      summary: Consultar saldo
      description: >-
        Retorna o saldo disponível para saque, limites configurados e o limite
        diário restante calculado em tempo real.
      operationId: getWithdrawalBalance
      responses:
        '200':
          description: Saldo consultado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBalanceSuccess'
              example:
                success: true
                message: Saldo consultado com sucesso!
                data:
                  available_balance: 1250000
                  daily_limit_remaining: 500000
                  minimum_withdrawal: 500
                  limits:
                    per_request: 500000
                    per_day_total: 1000000
        '401':
          description: Erro de autenticação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthErrorResponse'
              examples:
                credenciais_ausentes:
                  summary: Credenciais ausentes
                  value:
                    error: Credenciais inválidas
                    message: Chave pública e chave privada são obrigatórias
                credenciais_invalidas:
                  summary: Credenciais inválidas
                  value:
                    error: Credenciais inválidas
                    message: Chave não encontrada ou inativa
        '403':
          description: Erro de permissão
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                message: Esta credencial não tem permissão para realizar esta operação.
                data: null
        '500':
          description: Erro interno do servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                message: Ocorreu um erro ao consultar o saldo.
                data: null
components:
  schemas:
    GetBalanceSuccess:
      type: object
      properties:
        success:
          type: boolean
          description: Indica se a operação foi bem-sucedida.
        message:
          type: string
          description: Mensagem descritiva do resultado.
        data:
          type: object
          properties:
            available_balance:
              type: integer
              description: Saldo disponível para saque em centavos.
            daily_limit_remaining:
              type: integer
              nullable: true
              description: >-
                Limite diário restante em centavos. `null` se não houver limite
                diário configurado. Calculado em tempo real com base nos saques
                `paid` e `pending` do dia.
            minimum_withdrawal:
              type: integer
              description: Valor mínimo para saque em centavos.
            limits:
              type: object
              description: Limites de saque configurados para a conta.
              properties:
                per_request:
                  type: integer
                  nullable: true
                  description: >-
                    Limite máximo por solicitação de saque em centavos. `null`
                    se não houver limite configurado.
                per_day_total:
                  type: integer
                  nullable: true
                  description: >-
                    Limite diário total de saques em centavos. `null` se não
                    houver limite configurado.
    AuthErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Tipo do erro de autenticação.
        message:
          type: string
          description: Mensagem descritiva do erro.
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Sempre `false` em caso de erro.
        message:
          type: string
          description: Mensagem descritiva do erro.
        data:
          type: object
          nullable: true
          description: Sempre `null` em erros simples.
  securitySchemes:
    publicKey:
      type: apiKey
      in: header
      name: X-Public-Key
      description: 'Sua chave pública de acesso à API. Ex: `pk_live_abc123def456...`'
    secretKey:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: 'Sua chave secreta de acesso à API. Ex: `sk_live_xyz789ghi012...`'

````