Skip to main content
POST
Payout From 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_ + 32 hex).

Body

application/json
amountCents
integer
required

Valor BRUTO em centavos, debitado da subconta. Número JSON inteiro: string e decimal são recusados com 400. A taxa sai de dentro dele.

Required range: x >= 1
pixKey
string
required

Chave PIX de destino (CPF, CNPJ, e-mail, telefone ou aleatória).

Maximum string length: 200
idempotencyKey
string

Chave de idempotência OPCIONAL, no CORPO. Guardada sem prazo, junto do lançamento no extrato da subconta.

Maximum string length: 64
Pattern: ^[A-Za-z0-9_-]+$

Response

Saque enviado. netAmount é o que chegou na chave PIX: amount menos fee. Uma repetição com o mesmo idempotencyKey também responde 200, com idempotentReplay true e o corpo do saque ORIGINAL, sem enviar nada de novo.

success
boolean
withdrawal
object