Cancel GTT Order
This API allows you to cancel an existing pending GTT order.
🛣️ Endpoint
DELETE {{hosturl}}/transactional/v1/orders/regular/:market/:orderID
🛣️ Path Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| market | string | Yes | Exchange segments | NSE_FO |
| orderID | string | Yes | Order ID to cancel (URL encoded format) | NYMKL00016;< |
🔑 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 broker | x-api-key |
| Content-Type | string | Yes | Must be application/json | application/json |
🔍 Query Parameters
| Fields | Type | Required | Description | Example/Enum |
|---|---|---|---|---|
| validity | string | Yes | Order validity type. Must be GTT | GTT |
| validity_days | integer | Yes | Number of validity days | 0 |
🟢 Success Response – 200 OK
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| status | string | API call status | success |
| code | string | Response code | s-101 |
| message | string | Success message | Order Cancellation Sent to OMS |
| data | object | Contains the cancelled order ID | See below table |
📘 Data Object Fields
| Fields | Type | Description | Example/Enum |
|---|---|---|---|
| orderId | string | System-generated cancelled Order ID | "NYMKL00016;<" |
📋 Sample Response
{
"status": "success",
"code": "s-101",
"message": "Order Cancellation Sent to OMS",
"data": {
"orderId": "NYMKL00016;<"
}
}