Skip to main content

Reduce quota lock


Introduction​

This resource is used to reduce the quota lock value of an investor.

Available on
ProfileHostRequired permission
Managermanager-apiWrite

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/event
METHOD
POST
STATUS
201
Reduction 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​

FieldTypeDescriptionCharactersRequired
typestringEvent type enumeratorup to 255Yes
new_locked_valuefloatNew locked financial value-No
new_locked_quotasfloatNew number of locked quotas-No
net_valuefloatNet 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​

EnumeratorDescription
decrease_locked_quotasDecrease the number of locked quotas
decrease_locked_valueDecrease the locked financial value
collateral_executionCollateral 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.