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

# Consultar saldo

> Retorna o saldo agregado da subconta com os campos: identificador interno (internalId), disponível (available), agendado (scheduled) e reserva financeira (financialReserved). Todos os valores monetários são retornados em centavos.



## OpenAPI

````yaml GET /v1/submerchants/{internalId}/balance
openapi: 3.0.0
info:
  title: UvviPay Public API
  description: >-
    Endpoints públicos da plataforma UvviPay para integração de subcontas
    (submerchants).
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.uvvipay.com.br
    description: Produção
  - url: https://api-staging.uvvipay.com.br
    description: Staging
security:
  - client-id: []
    client-secret: []
tags: []
paths:
  /v1/submerchants/{internalId}/balance:
    get:
      tags:
        - Submerchants
      summary: Consultar saldo da subconta
      description: >-
        Retorna o saldo agregado da subconta com os campos: identificador
        interno (internalId), disponível (available), agendado (scheduled) e
        reserva financeira (financialReserved). Todos os valores monetários são
        retornados em centavos.
      operationId: getBalance
      parameters:
        - name: client-secret
          in: header
          description: Secret da credencial do merchant
          required: true
          schema:
            type: string
        - name: client-id
          in: header
          description: ID público da credencial do merchant
          required: true
          schema:
            type: string
        - name: internalId
          required: true
          in: path
          description: Identificador interno (UUID) da subconta
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Saldo da subconta retornado com sucesso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubmerchantBalanceResponseDto'
        '401':
          description: Credenciais inválidas ou ausentes
        '404':
          description: Subconta não encontrada
        '429':
          description: Limite de requisições excedido
components:
  schemas:
    SubmerchantBalanceResponseDto:
      type: object
      description: >-
        Saldo agregado da subconta. Todos os valores estão em centavos
        (inteiros).
      properties:
        internalId:
          type: string
          format: uuid
          description: Identificador interno (UUID) da subconta.
          example: 5b9f3d6a-3a2c-4d6f-9b9e-0a1b2c3d4e5f
        available:
          type: integer
          description: Saldo disponível para saque/uso, em centavos.
          example: 150000
        scheduled:
          type: integer
          description: Saldo agendado (a receber em datas futuras), em centavos.
          example: 250000
        financialReserved:
          type: integer
          description: Saldo em reserva financeira (retido), em centavos.
          example: 10000
      required:
        - internalId
        - available
        - scheduled
        - financialReserved
  securitySchemes:
    client-id:
      type: apiKey
      in: header
      name: client-id
    client-secret:
      type: apiKey
      in: header
      name: client-secret

````