Replace Vault Lock
Requests replacing a lock with a new lock at a new total amount. Owner only. Executed immediately unless a policy requires approval. On execution the lock is released, a new lock is created at the new amount (carrying over the owner, externalId and reason), and the new lock is returned. If a policy requires approval, responds 202 with the pending replace request instead.
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Vaults:Locks:Release: Always required.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}$Vault lock id.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$Body
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 update or delete it.
The reason or note the lock was created with.
Set when this lock was created by an update: the lock it replaces.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"
Set when this lock was released by an update: the lock that replaced it.
1 - 64^vlt-lck-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"vlt-lck-0lf1e-8a8ag-2ak7vrvusrj3so0j"