Skip to main content
GET
Get Subaccount

Authorizations

Authorization
string
header
required

Chave de API gerada no dashboard da PurinCash (ps_live_ ou ps_test_).

Path Parameters

id
string
required

ID da subconta (sacc_...).

Response

Subconta com medBlockedCents (valor preso por MED/disputa atribuída a vendas desta subconta: bloqueia, não debita) e availableCents (saldo menos esse bloqueio; é o que dá pra repassar enquanto a disputa vive). A listagem traz os mesmos dois campos por item.

subaccountId
string

ID da subconta, prefixo sacc_. Use em cobranças e consultas.

name
string
email
string
externalId
string

Seu ID para este cliente. Vazio quando não informado.

active
boolean

Subconta desativada não recebe novas cobranças nem entradas.

balanceCents
integer

Saldo atual do ledger, em centavos.

totalReceivedCents
integer

Total já creditado por vendas, sem descontar transferências.

feePercent
number

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
integer

Markup fixo em centavos, somado ao percentual.

payoutFeePercent
number

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
integer

Markup fixo de saque, em centavos, somado ao percentual.

metadata
string
createdAt
string<date-time>
updatedAt
string<date-time>
medBlockedCents
integer

Preso por disputas (MED) desta subconta.

availableCents
integer

balanceCents − medBlockedCents, nunca negativo.