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

# Consultar saldo

> Retorna o saldo disponível da organização da chave. Exige `balance:read`.



## OpenAPI

````yaml /openapi.json get /v1/balance
openapi: 3.1.0
info:
  title: MingoPay API
  version: 1.0.0
  description: >-
    API pública para cobranças Pix, subcontas, devoluções e consulta de saldo.
    Valores monetários em centavos; ambientes e saldos são isolados.
servers:
  - url: https://api.mingopay.com.br
    description: API MingoPay
security:
  - bearerAuth: []
tags:
  - name: Cobranças
    description: Criação, consulta e reconciliação de cobranças Pix.
  - name: Devoluções
    description: Devoluções parciais ou totais de cobranças pagas.
  - name: Saldo
    description: Saldo disponível calculado pelo ledger da organização.
  - name: Sandbox
    description: Simulações disponíveis somente para chaves mp_test_.
  - name: Subcontas
    description: >-
      Subcontas administradas pela sua organização, com cobranças e saldos
      separados.
paths:
  /v1/balance:
    get:
      tags:
        - Saldo
      summary: Consultar saldo
      description: >-
        Retorna o saldo disponível da organização da chave. Exige
        `balance:read`.
      operationId: getBalance
      responses:
        '200':
          description: Saldo disponível.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Balance'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Balance:
      type: object
      required:
        - availableCents
        - currency
        - calculatedAt
      properties:
        availableCents:
          type: integer
        currency:
          type: string
          const: BRL
        calculatedAt:
          type: string
          format: date-time
    ApiError:
      type: object
      required:
        - error
        - message
        - requestId
      properties:
        error:
          type: string
        message:
          type: string
        requestId:
          type: string
        details:
          type: array
          items:
            type: object
            required:
              - path
              - message
            properties:
              path:
                type: string
              message:
                type: string
  responses:
    Unauthorized:
      description: Chave ausente ou inválida.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: >-
        Ambiente, organização ou escopo não autorizado. Organizações suspensas
        (restricted) ou encerradas (closed) retornam organization_not_active em
        sandbox e produção.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Limite de requisições excedido.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API MingoPay com prefixo mp_test_ ou mp_live_.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.