Reduce quota lock
Introduction
This resource is used to reduce the quota lock value of an investor.
Available on
| Profile | Host | Required permission |
|---|---|---|
| Manager | manager-api | Write |
Base URL for each host: Environments (Hosts).
Request
ENDPOINT
/quota_lock/investor/INVESTOR_KEY/quota_lock/QUOTA_LOCK_KEY/investor_position_lock/INVESTOR_POSITION_LOCK_KEY/eventMETHOD
POSTSTATUS
201Reduction of locked value
{
"type": "decrease_locked_value",
"new_locked_value": 0.00
}
Reduction of the number of locked quotas
{
"type": "decrease_locked_quotas",
"new_locked_quotas": 0.00
}
Collateral execution
{
"type": "collateral_execution",
"net_value": 0.00
}
Locked Investor Position Event
| Field | Type | Description | Characters | Required |
|---|---|---|---|---|
type | string | Event type enumerator | up to 255 | Yes |
new_locked_value | float | New locked financial value | - | No |
new_locked_quotas | float | New number of locked quotas | - | No |
net_value | float | Net value determined in the collateral execution | - | No |
Exactly one — and only one — of new_locked_value, new_locked_quotas and net_value must be sent.
Event Type
| Enumerator | Description |
|---|---|
decrease_locked_quotas | Decrease the number of locked quotas |
decrease_locked_value | Decrease the locked financial value |
collateral_execution | Collateral execution |
The collateral_execution event has its own flow, prerequisites and tracking, described in Collateral execution.
Errors
Authentication, permission and host errors: see API Errors.