Skip to main content
POST
Transfer wallet credits to a subaccount

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Path Parameters

id
string
required

Subaccount (child organization) id.

Minimum string length: 1

Body

application/json
amount_cents
integer
required

Credits (cents) to transfer — 1–1,000,000 per call.

Required range: 1 <= x <= 1000000
note
string

Free-text audit note attached to the transfer.

Maximum string length: 500
client_reference_id
string

Caller-supplied idempotency key; a retry with the same (parent, child, amount, id) tuple is treated as the prior call so the parent is never double-charged.

Required string length: 1 - 128

Response

Successful response.

data
object
required
meta
object
required