Skip to main content
POST
Transfer Subaccount Balance

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Body

application/json
direction
enum<string>
required

Sentido da transferência.

Available options:
to_master,
to_subaccount
amountCents
integer
required

Valor em centavos. Número JSON inteiro: string e decimal são recusados com 400.

Required range: 1 <= x <= 100000000000
description
string

Texto livre que aparece no extrato.

Maximum string length: 200
idempotencyKey
string

Chave de idempotência OPCIONAL, enviada no CORPO (não existe header de idempotência nesta API). Com ela, repetir a mesma requisição devolve 200 com a transferência original e idempotentReplay true, em vez de mover o valor de novo. Vira o refId do lançamento com o prefixo idem_. Escopo: a subconta. Sem a chave, cada requisição é uma transferência nova.

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

Response

Repetição de uma transferência já registrada com o mesmo idempotencyKey. Nada foi movido de novo: o corpo descreve a transferência ORIGINAL e traz idempotentReplay true.

transferId
string
subaccountId
string
direction
enum<string>
Available options:
to_master,
to_subaccount
amountCents
integer
balanceCents
integer
idempotentReplay
boolean