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

# Consultar saldo

> Permissão necessária: balance:read.



## OpenAPI

````yaml https://api.nyxpag.com.br/v1/openapi.json get /balance
openapi: 3.1.0
info:
  title: NyxPag API
  version: 1.1.0
  description: >-
    API REST para cobranças Pix, consulta de saldo, verificação de transações,
    MEDs, transferências e webhooks. Cada API Key permite 100 requisições por
    janela de 60 segundos, iniciada na primeira chamada e compartilhada entre
    todas as rotas autenticadas, inclusive MCP.
  contact:
    email: suporte@nyxpag.com.br
    url: https://docs.nyxpag.com.br/
servers:
  - url: https://api.nyxpag.com.br/v1
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Saldo
    description: Saldos disponível e reservado.
  - name: Pagamentos
    description: Criação de cobranças Pix.
  - name: Transações
    description: Consulta e acompanhamento de operações.
  - name: MED
    description: >-
      Consulta de contestações Pix e acompanhamento do valor retido até a
      decisão.
  - name: Transferências
    description: Saques e transferências Pix em reais.
  - name: Transparência
    description: Indicadores públicos consolidados da plataforma.
externalDocs:
  description: Guias, exemplos e referência da NyxPag API
  url: https://docs.nyxpag.com.br/
paths:
  /balance:
    get:
      tags:
        - Saldo
      summary: Consultar saldo
      description: 'Permissão necessária: balance:read.'
      responses:
        '200':
          description: Saldo atual
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: object
                    properties:
                      currency:
                        type: string
                        example: BRL
                      available:
                        type: number
                        example: 1250.5
                      reserved:
                        type: number
                        example: 100
                  requestId:
                    type: string
        '400':
          description: Dados inválidos
        '401':
          description: API Key ausente, inválida ou revogada
        '403':
          description: Permissão ou endereço IP não autorizado
        '409':
          description: Conflito de idempotência
        '422':
          description: Operação recusada
        '429':
          description: >-
            Limite de 100 requisições por minuto por API Key, compartilhado
            entre todas as rotas autenticadas. Proteções adicionais por IP
            também podem retornar 429.
          headers:
            Retry-After:
              description: Segundos até poder tentar novamente.
              schema:
                type: integer
                minimum: 1
            RateLimit-Limit:
              description: Limite da política aplicada; 100 para a cota por API Key.
              schema:
                type: integer
                example: 100
            RateLimit-Remaining:
              description: Requisições restantes na janela.
              schema:
                type: integer
                example: 0
            RateLimit-Reset:
              description: Segundos até o fim da janela.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              example:
                success: false
                code: rate_limit_exceeded
                error:
                  code: rate_limit_exceeded
                  message: Muitas solicitações. Aguarde antes de tentar novamente.
                retryAfter: 60
                requestId: req_example
        '500':
          description: Erro interno
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: 'Use Authorization: Bearer nyx_live_...'

````

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