Skip to main content
POST
Vault withdraw

Headers

User-Wallet
string
required

Base58 wallet of the acting user; the transaction is built for this wallet. Missing header returns 401

payer
string | null

Base58 wallet that pays transaction fees; defaults to the User-Wallet wallet when omitted

Transaction-Settings
string | null

Optional JSON-encoded transaction settings (priority-fee percentile, compute limits, simulation mode)

Idempotent-Key
string | null

Optional idempotency key; a retried write with the same key replays the original response

Body

application/json
amountPrincipal
integer<int64>
required
Required range: x >= 0
maxAmountLp
integer<int64>
required
Required range: x >= 0
vault
string
required
withdrawAll
boolean
required
withdrawOnly
boolean

Response

Serialized transaction and update stake account

stakeAccount
string
required
transaction
object
required

versioned txn return

preTransactions
object[]

Unstake-only transactions that must be executed before the main transaction when consolidating more positions than fit in a single transaction.