Create Vault Lock
Locks funds from the vault’s available balance for off-chain settlement or escrow.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Vaults:Locks:Create: 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}$Body
The EVM network the locked asset is on.
ArbitrumOne, ArbitrumSepolia, ArcTestnet, AvalancheC, AvalancheCFuji, Base, BaseSepolia, Bob, BobSepolia, Bsc, BscTestnet, Berachain, BerachainBepolia, Celo, CeloAlfajores, Codex, CodexSepolia, Ethereum, EthereumClassic, EthereumClassicMordor, EthereumSepolia, EthereumHoodi, FlareC, FlareCCoston2, FlowEvm, FlowEvmTestnet, Ink, InkSepolia, Optimism, OptimismSepolia, Plasma, PlasmaTestnet, Plume, PlumeSepolia, Polygon, PolygonAmoy, Race, RaceSepolia, Rayls, RaylsTestnet, Robinhood, RobinhoodSepolia, SeiPacific1, SeiAtlantic2, Sonic, SonicTestnet, Tempo, TempoModerato, Tsc, TscTestnet1, Xdc, XdcApothem, XLayer, XLayerSepolia The token identifier of the asset to lock (e.g. native:eth or erc20:0x...).
The amount to lock, in minimum denomination.
^\d+$A unique id from your system. Unique per vault: it cannot be reused, even after the lock is deleted.
1 - 50An optional reason or note for the lock.
Response
Success
Vault lock object: funds manually locked for off-chain settlement or escrow.
Vault lock id.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"
The user that created the lock. Only this user can delete it.
The reason or note the lock was created with.