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

# Consultar saldos

> Retorna os saldos disponíveis para saque por tipo de transação

**Operação em subconta:**
Para buscar os saldos disponíveis de uma subconta, inclua o header `x-subaccount-id` com o ID da subconta. Quando este header é fornecido, a operação será realizada no contexto da subconta especificada, em vez da conta principal autenticada.



## OpenAPI

````yaml GET /withdrawals/balance
openapi: 3.1.0
info:
  title: OpenAPI Super APIs
  description: Documentação das APIs destinada a companhias da Super Pagamentos
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://sandbox-api.superpagamentos.com
    description: Ambiente de desenvolvimento
  - url: https://api.superpagamentos.com
    description: Ambiente de produção
security: []
paths:
  /withdrawals/balance:
    get:
      description: >-
        Retorna os saldos disponíveis para saque por tipo de transação


        **Operação em subconta:**

        Para buscar os saldos disponíveis de uma subconta, inclua o header
        `x-subaccount-id` com o ID da subconta. Quando este header é fornecido,
        a operação será realizada no contexto da subconta especificada, em vez
        da conta principal autenticada.
      parameters:
        - name: x-subaccount-id
          in: header
          description: >-
            ID da subconta onde a operação será realizada. Quando fornecido, a
            operação será executada no contexto desta subconta específica.
          required: false
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Saldos consultados com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      disponiblePixBalance:
                        type: number
                        description: Saldo disponível para saque de transações PIX
                      disponibleCardBalance:
                        type: number
                        description: Saldo disponível para saque de transações com cartão
                      disponibleBilletBalance:
                        type: number
                        description: Saldo disponível para saque de transações com boleto
                      withdrawalsInProcessingBalance:
                        type: number
                        description: Saldo em processamento de saques
                  message:
                    type: string
                    example: Saldos bancários
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Token JWT gerado na rota de autenticação (/auth). Deve ser enviado no
        formato: Bearer <token>

````