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

# Obter detalhes da Conta

> Permite que você recupere os detalhes da sua conta, incluindo informações de saldo.



## OpenAPI

````yaml GET /account
openapi: 3.1.0
info:
  title: API AobaPay
  description: API para gerenciamento de cobranças e pagamentos usando o AobaPay.
  version: 1.0.0
servers:
  - url: https://api.aobapay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /account:
    get:
      summary: Obter detalhes da conta
      description: >-
        Permite que você recupere os detalhes da sua conta, incluindo
        informações de saldo.
      responses:
        '200':
          description: Detalhes da conta retornados com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: 'null'
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 200
                  data:
                    $ref: '#/components/schemas/Account'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Mensagem de erro descrevendo o motivo da falha.
                    example: Header com Authorization está vazio
                  status:
                    type: integer
                    description: Código de status HTTP.
                    example: 401
                  data:
                    type: array
                    example: []
      security:
        - bearerAuth: []
components:
  schemas:
    Account:
      type: object
      description: Retorno .
      additionalProperties: false
      properties:
        accountID:
          type: string
          description: Identificador único da conta.
          example: '8918291298891829'
        taxID:
          type: string
          description: CNPJ da conta
          example: '12345678000199'
        name:
          type: string
          description: Nome da empresa.
          example: AOBA PAY LTDA
        fee:
          type: integer
          description: Taxa da empresa
          example: 78
        balance:
          type: object
          description: Informações de saldo da loja.
          additionalProperties: false
          properties:
            available:
              type: number
              description: Saldo disponível para saque em centavos.
              example: 15000
            pending:
              type: number
              description: Saldo pendente de confirmação em centavos.
              example: 5000
            blocked:
              type: number
              description: Saldo bloqueado em disputas em centavos.
              example: 2000
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer <aobapay-api-key>`
        onde `<aobapay-api-key>` é a sua chave de API.

````