(NEW 1.33) Apply Cash Distribution
POST {{URL_ORIGIN}}/api/operations/corporate-actions/apply-cash-distribution
Apply Cash Distribution API allows you to adjust active orders and current market data fields(not historical) in case of a Corporate Actions that results cash distributions (such as cash dividend).
Request Parameters:
| Field | Type | Description |
|---|---|---|
| instrumentId | Stringfied number | Instrument ID to apply the cash distribution |
| amount | Stringfied Decimal | Cash Amount per share Maximum 10 decimal places |
Response:
| Field | Description |
|---|---|
| numberOfOrders | The total number of active/suspended orders for the instrument before applying the corporate action |
| numberOfNewOrders | The number of new orders generated for the corporate action |
| numberOfCancelledOrders | The number of cancelled orders for the corporate action |
Error Codes
| Code | Message |
|---|---|
| 1 | System is unavailable |
| 10001 | Permission denied |
| 100 | Missing or invalid parameter: [FieldName] |
| 100 | [FieldName] must be ≤ [maxLong/10^ fieldPrecision] |
| 100 | [FieldName] must be ≥ [minLong/10^ fieldPrecision] |
| 102 | Instrument trading is not allowed |
| 102 | Trading is not allowed during auction call |
| 102 | Trading is not allowed during crossing |
| 102 | Instrument should be halted when market is open |
| 102 | Apply Cash Distribution is not allowed when there is no Closing Price |
Request Body
{"instrumentId"=>"77", "amount"=>"0.01"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
| `` | null |
RESPONSES
status: OK
{"numberOfOrders":"11","numberOfNewOrders":"7","numberOfCancelledOrders":"7"}