Sign in

v1

latestOpenAPI 3.1.02026-07-2619047.9 KB

Deposit SPL Tokens

Wraps the SDK delegateSpl(...) flow. The API generates shuttleId server-side and pins escrowIndex to 0.

post/v1/spl/deposit

Request body

ownerstring required
mintstring

Optional. Defaults to Solana USDC on mainnet: EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v. On devnet it defaults to devnet USDC: 4zMMC9srt5Ri5X14GAgXhaHii3GnPAEERYPJgZJDncDU.

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.

initVaultIfMissingboolean

Optional. Initialize the vault if missing.

initAtasIfMissingboolean

Optional. Initialize associated token accounts if missing.

idempotentboolean

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

privateboolean

Optional. When true, the deposited balance is kept private.

Example request

{
  "owner": "3rXKwQ1kpjBd5tdcco32qsvqUh1BnZjcYnS5kYrP7AYE",
  "amount": 1,
  "initIfMissing": true,
  "initVaultIfMissing": true,
  "initAtasIfMissing": true,
  "idempotent": true
}

Response

Unsigned serialized transaction

kind'deposit' required
version'legacy' | 'v0' required
transactionBase64string required
sendTo'base' | 'ephemeral' required
recentBlockhashstring required
lastValidBlockHeightinteger required
instructionCountinteger required
requiredSignersstring[] required
validatorstring