Cancel Multileg/Spread Order
This API cancels an existin multileg/spread order that is pending in order book
🛣️Path Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| order_flag | string | Yes | Action to be performed (should be cancel) | cancel |
| gateway_order_no | integer | yes | Gateway order number of the mutli-leg order | 0409005 |
🔑Header Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| Authorization | string | yes | Bearer token for authentication | access_token |
| x-api-key | string | Yes | API key provided by bearer | x-api-key |
| Content_type | string | yes | Type of content being sent | application/json |
📦Request Body Schema: application/json
| Fields | Type | Required | Description | Example/ENUM |
|---|---|---|---|---|
| type | string | yes | Type of multileg order | "SPREAD" "2L" "3L" |
| order_type | string | yes | Type of Order Supported : "RL" , "RL-MKT" | "RL" |
| validity | string | yes | Order Validity. Ususally: "IOC" | "IOC" |
| leg_details | array of object | yes | Details of each leg of the order | See below table |
📘Leg Details object fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| leg_no | integer | Yes | Identifieer of the leg | 1 |
| scrip_info | object | yes | Instrument details | See below table |
| trasactional_type | string | yes | Buy or sell | SELL |
| quantity | number | yes | Quantity for this leg | 75 |
| price | string | Yes | Price of the leg | "250.50" |
| orders | object | Yes | Lot size and prize tick details | See below tabe |
📑Scrip info object fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| exchange | string | yes | Exchange segments | NSE_FO |
| scrip_token | integer | Optional | Unique token id of the instrument | 123456 |
| symbol | string | Optional | Symbol of the scrip | RELIANCE  |
| series | string | Optional | Series (for equities) | EQ |
| expiry_date | string | Optional | Expiry date (yyyy-mm-dd) for F&O | 2025-06-05 |
| strike_price | number | Optional | Strike price in paise (for options) | 255000 |
| option_type | string | Optional | option type: "CE" call or "PE" put | PE |
📑Others object fields
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| market_lot | integer | Yes | Lotsize | 75 |
| price_tick | number | Yes | Price movement increment | 0.05 |
| decimal_loc | number | Yes | Decimal locator for precision | 2 |
🟢Success Response - 200 OK
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| Status | string | Status of API Call | "success" |
| Code | string | Response code | "s-101" |
| message | string | Confirmation Message | "Order submitted for cancellation" |
| data | object | Contain additional details | See below table |
📄Data Object Info Field
| Field | Type | Description | Example/Enum |
|---|---|---|---|
| order id | string | Internal order ID assigned by system | "SPRD12345" |
| gateway_order_no | string | Gateway order reference number | "04567435 |
put
/transactional/v1/orders/multileg/{order_flag}/{gateway_order_no}