Skip to main content
GET
Get Wallet

Authorizations

Authorization
string
header
required

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

Response

Saldo da carteira.

currency
string

Moeda do saldo. Sempre "BRL".

balance
number

Saldo bruto da carteira (BRL).

balanceCents
integer

Saldo bruto da carteira em centavos.

disputeBlocked
number

Valor retido por disputas (MED) abertas ou perdidas não perdoadas (BRL). Sempre 0 no sandbox.

withdrawable
number

Saldo sacável agora (balance - disputeBlocked - comprometido com subcontas). É o valor máximo que o POST /v1/payouts aceita sacar. Pedidos acima disso são rejeitados com o motivo detalhado.

withdrawableCents
integer

Saldo sacável em centavos.

pendingRelease
number

Vendas no cartão aguardando liberação (BRL).

pendingReleaseCents
integer

Liberação pendente de cartão em centavos.

subaccountsCommittedCents
integer | null

Soma dos saldos das suas subcontas: a fatia do saldo que pertence aos seus clientes e que o saque da conta principal NÃO alcança. null = não pôde ser calculada (e aí o withdrawable exibido não desconta; o débito real continua bloqueando).

unattributedCents
integer | null

O que a carteira tem sem dono: o teto que a transferência to_subaccount aceita atribuir. Coincide com withdrawableCents agora que o saque desconta o comprometido. null quando a soma falhou.

cryptoBalanceLtc
number

Saldo em LTC (saque via POST /v1/payouts com method "ltc"). Sempre 0 no sandbox.

sandbox
boolean

Presente e true apenas com chave ps_test_. Saldo simulado a partir dos pagamentos de teste.