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

# Get Subaccount

> Detalhes de uma subconta, incluindo saldo atual e total recebido.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/subaccounts/{id}
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purincash.com
    description: Produção
security:
  - bearerAuth: []
tags:
  - name: Cartao
    description: Pagamentos no cartao de credito.
  - name: Cobrancas
    description: Cobrancas PIX avulsas com valor livre.
  - name: Entregas
    description: Conteudo entregue automaticamente apos o pagamento.
  - name: Disputas
    description: Contestacoes (MED) e envio de evidencias.
  - name: Pagamentos
    description: Pagamentos PIX e LTC vinculados ou nao a um produto.
  - name: Saques
    description: Saques em PIX, LTC e USDT.
  - name: Produtos
    description: Produtos de cobranca criados pela API.
  - name: Sandbox
    description: Simulacao de pagamentos e saldo de teste.
  - name: Splits
    description: Cobrancas divididas entre varias contas.
  - name: Loja
    description: Produtos da loja do Discord (somente leitura).
  - name: Subcontas
    description: Ledger de saldo por cliente do integrador.
  - name: Assinaturas
    description: PIX recorrente.
  - name: Carteira
    description: Saldo, retencoes e valores a liberar.
paths:
  /v1/subaccounts/{id}:
    get:
      tags:
        - Subcontas
      summary: Get Subaccount
      description: Detalhes de uma subconta, incluindo saldo atual e total recebido.
      operationId: getSubaccount
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID da subconta (sacc_...).
      responses:
        '200':
          description: Subconta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Subaccount'
        '404':
          description: Subconta inexistente ou de outra conta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Subaccount not found
        '500':
          description: Erro interno.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Subaccount:
      type: object
      properties:
        subaccountId:
          type: string
          description: ID da subconta, prefixo sacc_. Use em cobranças e consultas.
        name:
          type: string
        email:
          type: string
        externalId:
          type: string
          description: Seu ID para este cliente. Vazio quando não informado.
        active:
          type: boolean
          description: Subconta desativada não recebe novas cobranças nem entradas.
        balanceCents:
          type: integer
          description: Saldo atual do ledger, em centavos.
        totalReceivedCents:
          type: integer
          description: Total já creditado por vendas, sem descontar transferências.
        metadata:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Error:
      type: object
      properties:
        error:
          type: string
          description: >-
            Mensagem de erro legivel. Trate pelo codigo HTTP; o texto pode
            mudar.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

````