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

# Obter Dados da Conta

> Retorna os dados da conta, informações da empresa e saldo disponível.

**Permissão requerida:** `ACCOUNT:READ` ou `FULL_ACCESS`



## OpenAPI

````yaml GET /account
openapi: 3.0.0
info:
  title: pague.dev API
  description: pague.dev Payment API documentation
  version: '1.0'
  contact: {}
servers:
  - url: https://api.pague.dev/v1
security: []
paths:
  /account:
    get:
      tags:
        - External API - Account (Conta)
      summary: Obter dados da conta e saldo
      description: |-
        Retorna os dados da conta, informações da empresa e saldo disponível.

        **Permissão requerida:** `ACCOUNT:READ` ou `FULL_ACCESS`
      operationId: ExternalAccountController_getAccountInfo
      parameters:
        - name: X-API-Key
          in: header
          description: >-
            Chave de API de integração (pd_live_* para produção, pd_test_* para
            sandbox)
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Dados da conta, empresa e saldo
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoOutput'
        '401':
          description: Unauthorized - Authentication required
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedErrorResponse'
        '403':
          description: Forbidden - Permission denied
          content:
            application/json:
              schema:
                $ref: 23efc5e9-4837-4eba-a78d-316b3a481705
        '404':
          description: Not Found - Account not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
components:
  schemas:
    GetAccountInfoOutput:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountInfoDetail'
          description: Dados da conta
        company:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/CompanyInfoDetail'
          description: Dados da empresa (null se não cadastrada)
        balance:
          $ref: '#/components/schemas/BalanceInfoDetail'
          description: Saldo da conta
      required:
        - account
        - company
        - balance
    UnauthorizedErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 401
        error:
          type: string
          example: Unauthorized
        message:
          type: string
          example: Authentication token is required
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    NotFoundErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 404
        error:
          type: string
          example: NotFound
        message:
          type: string
          example: Resource with id 550e8400-e29b-41d4-a716-446655440000 not found
        details:
          type: object
          example:
            resource: Example
            id: 550e8400-e29b-41d4-a716-446655440000
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
      required:
        - statusCode
        - error
        - message
        - timestamp
    InternalServerErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 500
        error:
          type: string
          example: InternalError
        message:
          type: string
          example: An unexpected error occurred
        details:
          type: object
        timestamp:
          type: string
          example: '2025-12-15T22:00:00.000Z'
        traceId:
          type: string
          example: 2771463d58840c8e116dc6dda1e1e5d0
      required:
        - statusCode
        - error
        - message
        - timestamp
    AccountInfoDetail:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: ID da conta
        status:
          type: string
          enum:
            - approved
            - pending
            - pending_documents
            - pending_approval
            - rejected
            - suspended
          description: Status da conta
      required:
        - id
        - status
    CompanyInfoDetail:
      type: object
      nullable: true
      properties:
        razaoSocial:
          type: string
          description: Razão social da empresa
        nomeFantasia:
          type: string
          description: Nome fantasia da empresa
        cnpj:
          type: string
          description: CNPJ da empresa
        email:
          type: string
          description: Email da empresa
        phone:
          type: string
          description: Telefone da empresa
        status:
          type: string
          enum:
            - pending
            - active
            - suspended
            - blocked
          description: Status da empresa
      required:
        - razaoSocial
        - cnpj
        - email
        - phone
        - status
    BalanceInfoDetail:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Saldo disponível (conta principal)
        promotional:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Saldo promocional
        held:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Saldo bloqueado
        total:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Saldo total (disponível + promocional)
        currency:
          type: string
          description: Código da moeda
          example: BRL
        updatedAt:
          type: string
          format: date-time
          description: Data da última atualização do saldo
      required:
        - available
        - promotional
        - held
        - total
        - currency
        - updatedAt
    BalanceAmountDetail:
      type: object
      properties:
        amount:
          type: number
          description: Saldo em centavos
          example: 150000
        amountFormatted:
          type: number
          description: Saldo formatado em reais (amount / 100)
          example: 1500
      required:
        - amount
        - amountFormatted

````