v1

latestOpenAPI 3.1.02026-07-2619047.9 KB

Withdraw SPL Tokens

Wraps the SDK withdrawSpl(...) flow. The API generates shuttleId server-side.

post/v1/spl/withdraw

Request body

ownerstring required

mintstring required

SPL mint on Solana.

amountinteger required

Base-unit amount as an integer JSON value with minimum 1.

validatorstring

Optional. Defaults to the selected ephemeral RPC identity resolved via getIdentity.

initIfMissingboolean

Optional. Initialize the transfer queue if missing.

initAtasIfMissingboolean

Optional. Initialize associated token accounts if missing.

escrowIndexinteger

Optional. Escrow index for the withdrawal.

idempotentboolean

Optional. When true, the API uses idempotent variants for any preparatory init instructions.

Example request

{
  "owner": "3rXKwQ1kpjBd5tdcco32qsvqUh1BnZjcYnS5kYrP7AYE",
  "mint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
  "amount": 1000000,
  "idempotent": true
}

Response

Unsigned serialized transaction

kind'withdraw' required

version'legacy' | 'v0' required

transactionBase64string required

sendTo'base' | 'ephemeral' required

recentBlockhashstring required

lastValidBlockHeightinteger required

instructionCountinteger required

requiredSignersstring[] required

validatorstring