> ## 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.

# Get Account Details

> Returns the account details, company information, and available balance.

**Required permission:** `ACCOUNT:READ` or `FULL_ACCESS`



## OpenAPI

````yaml openapi.en.json 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-gateway.pague.dev/v2
security: []
paths:
  /account:
    get:
      tags:
        - External API - Account (Conta)
      summary: Get account details and balance
      description: |-
        Returns the account details, company information, and available balance.

        **Required permission:** `ACCOUNT:READ` or `FULL_ACCESS`
      operationId: ExternalAccountController_getAccountInfo
      parameters:
        - $ref: '#/components/parameters/SubAccount'
      responses:
        '200':
          description: Account details and balance
          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: '#/components/schemas/ForbiddenErrorResponse'
        '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'
      security:
        - bearerAuth: []
components:
  parameters:
    SubAccount:
      name: X-Sub-Account
      in: header
      required: false
      description: >-
        Reference of the sub-account the operation runs against. When omitted,
        the operation happens on the main account; the reserved value
        `principal` also resolves to the main account and is equivalent to
        omitting the header. Accepted on every endpoint except `POST /auth` and
        the `/sub-accounts` endpoints themselves, which always operate on the
        main account.


        Possible errors: `404 SUB_ACCOUNT_NOT_FOUND`, `403
        SUB_ACCOUNT_FORBIDDEN`, `403 SUB_ACCOUNT_SUSPENDED`.


        Requires the credential to have **sub-account access** enabled (Settings
        → Integration → API Credentials). It starts turned off and is not
        replaced by any permission, not even `FULL_ACCESS`: without it the
        response is `403 SUB_ACCOUNT_FORBIDDEN`.
      schema:
        type: string
        pattern: ^[a-z0-9][a-z0-9_-]{1,31}$
        example: loja-centro
  schemas:
    GetAccountInfoOutput:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/AccountInfoDetail'
          description: Account details
        balance:
          $ref: '#/components/schemas/BalanceInfoDetail'
          description: Account balance
      required:
        - account
        - 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
    ForbiddenErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          example: 403
        error:
          type: string
          example: Forbidden
        message:
          type: string
          example: You do not have permission to access this resource
        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
          description: Account ID
          format: uuid
        status:
          type: string
          enum:
            - approved
            - pending
            - pending_documents
            - pending_approval
            - rejected
            - suspended
          description: Account status
      required:
        - id
        - status
    BalanceInfoDetail:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Available balance (main account)
        promotional:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Promotional balance
        held:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Blocked balance
        total:
          $ref: '#/components/schemas/BalanceAmountDetail'
          description: Total balance (available + promotional)
        currency:
          type: string
          description: Currency code
          example: BRL
        updatedAt:
          type: string
          format: date-time
          description: Date of the last balance update
      required:
        - available
        - promotional
        - held
        - total
        - currency
        - updatedAt
    BalanceAmountDetail:
      type: object
      properties:
        amount:
          type: number
          description: Balance in cents
          example: 150000
        amountFormatted:
          type: number
          description: Balance formatted in BRL (amount / 100)
          example: 1500
      required:
        - amount
        - amountFormatted
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Access token obtained from POST /auth (client_id + client_secret). Valid
        for 300 seconds.

````