Cancel Order
POST/v1.1.1/order/cancel
Order status will change according to following sequence.
1.Send to Cancel
2.Pending Cancel
3.Cancelled or Reject
When canceling OMS-accepted orders, this API does not return a new orderReferenceId; instead, it returns the previous orderReferenceId obtained when placing the order.
orderId or orderReferenceId should be required.
Field Name | Equity | Option | Fixed Income |
---|---|---|---|
orderId | optional | optional | optional |
orderReferenceId | optional | optional | optional |
Request
- application/json
Body
orderId string
orderReferenceId string
Responses
- 200
- 401
OK
- application/json
- Schema
- Example (from schema)
- Example
Schema
status stringrequired
reason stringrequired
orderReferenceId stringrequired
{
"status": "string",
"reason": "string",
"orderReferenceId": "string"
}
{
"status": "SUCCESS",
"reason": "Order sent to OMS",
"orderReferenceId": "a38d849845cf"
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- Invalid Token
- Expired Token
Schema
timestamp string
status stringrequired
error stringrequired
message string
path string
rejectCode stringrequired
{
"timestamp": "string",
"status": "string",
"error": "string",
"message": "string",
"path": "string",
"rejectCode": "string"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Invalid Token",
"path": "/api/v1.1.1/order/cancel",
"rejectCode": "1008"
}
{
"timestamp": "2023-12-28T09:51:50.682Z",
"status": "401",
"error": "Unauthorized",
"message": "Expired Token",
"path": "/api/v1.1.1/order/cancel",
"rejectCode": "1007"
}
Loading...
Is this page helpful for you?