Transfer Vault Lock
Sends part or all of the locked amount to the lock’s beneficiary, paying the network fee from the vault’s available balance. Owner only, not subject to policies. Returns the outgoing transfer. The funds stay locked while it is in flight; once confirmed the lock is deleted and any unsent remainder returns to the available balance. If the transfer fails the lock stays in place and can be transferred again.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Vaults:Locks:Transfer: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Path Parameters
Vault id.
1 - 64^vlt-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Vault lock id.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Body
The amount to send to the lock's beneficiary, in minimum denomination. At most the locked amount; the unsent remainder returns to the vault's available balance once the transfer is confirmed.
^\d+$Response
Success
Transfer id.
1 - 64^xfr-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"xfr-20g4k-nsdpo-mg6arrifgvid4orn"
The source wallet for this tranfer.
1 - 64^wa-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"wa-5pfuu-9euek-h0odgb6snva8ph3k"
The blockchain network this transfer is on.
Algorand, AlgorandTestnet, Aptos, AptosTestnet, ArbitrumOne, ArbitrumSepolia, Arc, ArcTestnet, Areum, AvalancheC, AvalancheCFuji, Base, BaseSepolia, Berachain, BerachainBepolia, Bitcoin, BitcoinSignet, BitcoinTestnet4, BitcoinCash, Bob, BobSepolia, Bsc, BscTestnet, Canton, CantonTestnet, Cardano, CardanoPreprod, Concordium, ConcordiumTestnet, Celo, CeloAlfajores, Codex, CodexSepolia, CosmosHub4, CosmosIcsTestnet, Dogecoin, DogecoinTestnet, Ethereum, EthereumClassic, EthereumClassicMordor, EthereumSepolia, EthereumHoodi, FlareC, FlareCCoston2, FlowEvm, FlowEvmTestnet, Hedera, HederaTestnet, Ink, InkSepolia, InternetComputer, Ion, IonTestnet, Iota, IotaTestnet, Kusama, KusamaAssetHub, Litecoin, LitecoinTestnet, Movement, MovementTestnet, Near, NearTestnet, Optimism, OptimismSepolia, Origyn, Plasma, PlasmaTestnet, Plume, PlumeSepolia, Paseo, PaseoAssetHub, Polkadot, PolkadotAssetHub, Polygon, PolygonAmoy, Polymesh, PolymeshTestnet, Rayls, RaylsTestnet, Robinhood, RobinhoodSepolia, SeiAtlantic2, SeiPacific1, Solana, SolanaDevnet, Sonic, SonicTestnet, Starknet, StarknetSepolia, Stellar, StellarTestnet, Sui, SuiTestnet, Tezos, TezosShadownet, Tempo, TempoModerato, Tsc, TscTestnet1, Ton, TonTestnet, Tron, TronNile, Westend, WestendAssetHub, Xdc, XdcApothem, XLayer, XLayerSepolia, XrpLedger, XrpLedgerTestnet The user who initiated the request.
- Native Asset
- EVM Fungible Token (ERC-20)
- Aptos Fungible Asset (AIP-21)
- Algorand Standard Asset
- Cardano Asset
- Canton Standard Token (CIP-56)
- CIS-2 Standard
- Concordium Protocol Level Token (CIS-7)
- Sui Coin
- EVM Non Fungible Token (ERC-721)
- EVM Confidential Token (ERC-7984)
- Hedera Non-Fungible Token (HIP-17)
- Hedera Tokens (HTS)
- XRPL IOU Token
- Stellar Classic Assets (SEP-41)
- Starknet SNIP-2 (ERC-20 like)
- Starknet SNIP-3 (ERC-721-like)
- Solana Program Library Token (SPL and SPL 2022)
- TON Jetton (TEP-74)
- TRON Native Fungible Token (TRC-10)
- TRON Smart Contract Fungible Token (TRC-20)
- TRON Non Fungible Token (TRC-721)
- XRPL XLS-33 Token
Additional metadata about the transfered asset.
Transfer status.
Pending, Executing, Broadcasted, Confirmed, Failed, Rejected The reason for a failed transfer.
The blockchain transaction hash for this transfer.
The fee paid for this transfer in minimum denomination.
The id of the approval request if this transfer triggered a policy.
1 - 64^ap-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"ap-2a9in-tt2a1-983lho480p35ejd0"
The external id provided at transfer creation time.
The fee sponsor id used to pay for the transfer fees.
1 - 64^fs-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"fs-5vqdl-gliqk-b4rfukqauov1sp7j"
The id of the replacement transaction (cancel or speed-up) issued for this transfer.
Structured representation of the data used to construct the signature (e.g. nonce, gas parameters). Shape is blockchain specific.