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

# Buscar subconta

> Busca uma subconta pelo ID, com o saldo atual.

Busca uma subconta pelo ID, com o saldo atual.

> [card]
>
> Requer a permissão `SUB_ACCOUNT:READ`.

Informe o ID `sacc_` no parâmetro `id`. Se a subconta não existe na sua loja, a API responde com o erro `Sub account not found`.


## OpenAPI

````yaml GET /sub-accounts/get
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v2
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /sub-accounts/get:
    get:
      summary: Buscar subconta
      description: Busca uma subconta pelo ID, com o saldo atual.
      parameters:
        - name: id
          in: query
          description: ID da subconta.
          required: true
          schema:
            type: string
            example: sacc_9f8Kq2LmX4vTzR7pWn3bYc1H
      responses:
        '200':
          description: Subconta encontrada.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/SubAccount'
                  error:
                    type: string
                    nullable: true
                    example: null
                  success:
                    $ref: '#/components/schemas/Success'
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    SubAccount:
      type: object
      description: Subconta de um vendedor, com o saldo atual.
      properties:
        id:
          type: string
          description: ID único da subconta.
          example: sacc_9f8Kq2LmX4vTzR7pWn3bYc1H
        name:
          type: string
          description: Nome do titular.
          example: João da Silva
        taxId:
          type: string
          description: CPF ou CNPJ do titular, só dígitos.
          example: '11144477735'
        externalId:
          type: string
          nullable: true
          description: Identificador no seu sistema.
          example: vendedor-42
        balance:
          type: object
          description: Saldo da subconta em centavos.
          properties:
            available:
              type: integer
              description: Disponível para saque.
              example: 7000
            blocked:
              type: integer
              description: Retido.
              example: 0
        devMode:
          type: boolean
          description: Indica se a subconta foi criada em ambiente de testes.
          example: false
        metadata:
          type: object
          additionalProperties:
            type: string
          example:
            loja: centro
        createdAt:
          type: string
          format: date-time
          example: '2026-10-26T14:22:10.381Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-10-26T14:22:10.381Z'
    Success:
      type: boolean
      description: Se a requisição obteve sucesso ou não.
      example: true
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Todas as requisições devem incluir sua chave de API no header
        Authorization usando o formato `Bearer <abacatepay-api-key>`. Sem esse
        header a requisição será rejeitada.


        Saiba mais sobre como criar e usar chaves de API na [documentação de
        autenticação](/pages/authentication).

````

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