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

# Consultar conta

> Exige read. O saldo é o último valor confirmado do negócio selecionado.



## OpenAPI

````yaml /openapi.yaml get /account
openapi: 3.1.0
info:
  title: Master API
  version: 1.1.0
  description: >-
    API pública da Master para cobranças Pix, cartão e transferências Pix
    automáticas. Valores em centavos inteiros.
servers:
  - url: https://api.pagmaster.site/api/v1/public
    description: Produção, após configurar DNS e HTTPS
  - url: http://127.0.0.1:4000/api/v1/public
    description: Desenvolvimento local
security:
  - bearerAuth: []
tags:
  - name: Conta
    description: Saldo e limites da conta
  - name: Pagamentos
    description: Consulta de operações
  - name: Cobranças Pix
    description: Criação de cobranças
  - name: Transferências Pix
    description: Envios automáticos autorizados por API key
  - name: Operações de negócio
    description: Até 10 negócios com saldos e históricos independentes
  - name: Cartão de crédito
    description: Checkout hospedado e consulta de aprovação e liquidação
paths:
  /account:
    parameters:
      - $ref: '#/components/parameters/BusinessOperationHeader'
    get:
      tags:
        - Conta
      summary: Consultar conta
      description: Exige read. O saldo é o último valor confirmado do negócio selecionado.
      operationId: getAccount
      responses:
        '200':
          description: Estado da conta
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimit'
components:
  parameters:
    BusinessOperationHeader:
      name: X-Master-Operation
      in: header
      required: false
      description: >-
        UUID do negócio selecionado. Sem este header, utiliza a operação
        principal.
      schema:
        type: string
        format: uuid
  schemas:
    Account:
      type: object
      required:
        - enabled
        - balanceCents
        - balanceUpdatedAt
        - minimumDepositCents
        - maximumDepositCents
        - operationId
        - feeCents
        - heldBalanceCents
        - withdrawalsFrozen
        - minimumWithdrawalCents
        - maximumWithdrawalCents
        - reservedWithdrawalCents
        - cardFeeCents
        - minimumCardCents
        - maximumCardCents
      properties:
        enabled:
          type: boolean
          description: Se o processamento de pagamentos está habilitado
        balanceCents:
          type: integer
          example: 9750
          description: >-
            Saldo disponível após reservas de saque, retenções administrativas e
            margem da Master
        balanceUpdatedAt:
          type:
            - integer
            - 'null'
          description: Última sincronização do saldo, em milissegundos Unix
        minimumDepositCents:
          type: integer
          example: 200
        maximumDepositCents:
          type: integer
          example: 200000
        minimumWithdrawalCents:
          type: integer
          const: 1000
        maximumWithdrawalCents:
          type: integer
          const: 1000000
        reservedWithdrawalCents:
          type: integer
          minimum: 0
          description: Saldo reservado para saques autorizados ainda não reconciliados
        operationId:
          type: string
          format: uuid
          description: Identificador do negócio
        feeCents:
          type: integer
          minimum: 0
        heldBalanceCents:
          type: integer
          minimum: 0
          description: Retenção administrativa do negócio principal, em centavos
        withdrawalsFrozen:
          type: boolean
          description: Bloqueio de saques da conta ou plataforma
        cardFeeCents:
          type: integer
          minimum: 0
          example: 424
          description: Tarifa por cartão aprovado
        minimumCardCents:
          type: integer
          const: 500
        maximumCardCents:
          type: integer
          const: 200000
    Error:
      type: object
      properties:
        statusCode:
          type: integer
        message:
          oneOf:
            - type: string
            - type: array
              items:
                type: string
  responses:
    BadRequest:
      description: Dados inválidos ou conflito de idempotência
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: API key ausente, inválida ou revogada
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Permissão insuficiente
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Operação não encontrada nesta conta
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimit:
      description: Limite temporário de requisições
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key criada em Integrações → Keys. Exemplo `mk_live_...`.

````

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