Skip to main content
GET
Get withdrawal

Authorizations

Authorization
string
header
required

Scoped API key from the Totalis app settings. Each key acts for one account, yours or a maker's, and holds only scopes that account can use. Each operation lists the scopes it requires.

Path Parameters

withdrawal_id
string<uuid>
required

Withdrawal ID returned when the withdrawal was started.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

The withdrawal as it stands now, for example after a reload, a reconnect or a lost create response. The account stream pushes every change as WITHDRAWAL_UPDATED with this same resource.

withdrawal_id
string<uuid>
required

Server-assigned ID of this withdrawal.

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
account
string
required

Embedded wallet that pays out.

Pattern: ^0x[0-9a-f]{40}$
destination
string
required

External address that receives the USDC.

Pattern: ^0x[0-9a-f]{40}$
amount
string<uint128-decimal>
required

Total amount sent to destination, in atomic USDC (6 decimals).

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
shortfall_amount
string<uint128-decimal>
required

Part of amount first withdrawn from the vault to the wallet, in atomic USDC; "0" when the wallet already covered it.

Maximum string length: 39
Pattern: ^(0|[1-9][0-9]*)$
status
enum<string>
required

VAULT_WITHDRAWAL_QUEUED: the vault top-up is queued and the payout waits for it; PAYOUT_SUBMITTED: the payout is queued or relayed; PAYOUT_COMMITTED: destination received amount (terminal); FAILED: the withdrawal stopped and nothing left the Totalis balance: a vault top-up that committed stays in the wallet (terminal).

Available options:
VAULT_WITHDRAWAL_QUEUED,
PAYOUT_SUBMITTED,
PAYOUT_COMMITTED,
FAILED
vault_operation_id
string | null
required

Operation of the vault top-up; null when there is no shortfall.

Pattern: ^0x[0-9a-f]{64}$
payout_operation_id
string | null
required

Operation of the relayed payout; null until the vault top-up commits.

Pattern: ^0x[0-9a-f]{64}$
payout_transaction_hash
string | null
required

HyperEVM transaction of the payout; null until it is broadcast.

Pattern: ^0x[0-9a-f]{64}$
updated_at
string<date-time>
required

When the withdrawal last changed, RFC3339 UTC.

Maximum string length: 30
Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}([.][0-9]{1,9})?Z$