Skip to main content
GET
Get Subaccount Payout

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_ + 32 hex).

payoutId
string
required

O saque: saq_idem_<sua idempotencyKey>, saq_..., TURBO-..., SUB-... ou o withdrawal.id (24 hex) da resposta do saque.

Response

O saque, no estado atual.

payoutId
string | null

O refId do lançamento payout no extrato da subconta.

withdrawalId
string | null

O mesmo withdrawal.id da resposta do saque. null enquanto o saque ainda está sendo criado.

code
string | null

TURBO-... ou, no saque recusado antes do banco, SUB-....

subaccountId
string
status
enum<string>
Available options:
completed,
processing,
failed
reversed
boolean

O valor voltou para a subconta.

amountCents
integer

Bruto debitado da subconta.

feeCents
integer

Markup de saque da subconta, dentro do bruto.

platformFeeCents
integer | null

Taxa do saque.

netAmountCents
integer | null

O que a chave PIX recebe.

pixKey
string | null

Chave de destino, mascarada.

endToEndId
string | null

Identificador do PIX no banco. É por ele que quem recebeu acha o crédito.

recipientName
string | null
recipientBankName
string | null
failureReason
string | null

Só com status failed.

createdAt
string<date-time>

Quando a subconta foi debitada.

completedAt
string<date-time> | null
reversedAt
string<date-time> | null