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

# List Subaccounts

> Lista as subcontas da conta, mais recentes primeiro. Cada item já vem com medBlockedCents e availableCents, iguais aos do GET individual: uma tela de repasse em lote não precisa de uma chamada por subconta.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/subaccounts
openapi: 3.1.0
info:
  title: PurinCash API
  version: 1.0.0
servers:
  - url: https://api.purin.cash
    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:
    get:
      tags:
        - Subcontas
      summary: List Subaccounts
      description: >-
        Lista as subcontas da conta, mais recentes primeiro. Cada item já vem
        com medBlockedCents e availableCents, iguais aos do GET individual: uma
        tela de repasse em lote não precisa de uma chamada por subconta.
      operationId: listSubaccounts
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
          description: Resultados por página.
        - name: offset
          in: query
          schema:
            type: integer
            minimum: 0
            default: 0
          description: Pular N resultados.
        - name: status
          in: query
          schema:
            type: string
            enum:
              - active
              - inactive
          description: Filtrar por situação.
        - name: externalId
          in: query
          schema:
            type: string
          description: Busca exata pelo seu ID externo.
      responses:
        '200':
          description: Página de subcontas.
          content:
            application/json:
              schema:
                type: object
                properties:
                  subaccounts:
                    type: array
                    items:
                      allOf:
                        - $ref: '#/components/schemas/Subaccount'
                        - type: object
                          properties:
                            medBlockedCents:
                              type: integer
                              description: Preso por disputas (MED) desta subconta.
                            availableCents:
                              type: integer
                              description: balanceCents − medBlockedCents, nunca negativo.
                  total:
                    type: integer
                  limit:
                    type: integer
                  offset:
                    type: integer
              example:
                subaccounts:
                  - subaccountId: sacc_a1b2c3d4e5f60718293a4b5c6d7e8f90
                    name: Loja do João
                    email: joao@exemplo.com
                    externalId: cliente_42
                    active: true
                    balanceCents: 45900
                    totalReceivedCents: 78400
                    medBlockedCents: 0
                    availableCents: 45900
                    metadata: '{}'
                    createdAt: '2026-08-01T10:00:00.000Z'
                    updatedAt: '2026-08-04T12:05:00.000Z'
                total: 1
                limit: 50
                offset: 0
        '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.
        feePercent:
          type: number
          description: >-
            Markup percentual da plataforma sobre cada venda desta subconta (0 a
            100, até 2 casas). Descontado do líquido ANTES do crédito; a fatia
            fica na conta principal.
        feeFixedCents:
          type: integer
          description: Markup fixo em centavos, somado ao percentual.
        payoutFeePercent:
          type: number
          description: >-
            Markup percentual sobre cada SAQUE desta subconta (0 a 100, até 2
            casas). A subconta é debitada o valor cheio e o PIX sai pelo
            líquido: a diferença fica na conta principal.
        payoutFeeFixedCents:
          type: integer
          description: Markup fixo de saque, em centavos, somado ao percentual.
        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_).

````

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