Amend Order

POST 
/v1.1/order/amend

Order status will change according to following sequence.

1. Send to Amend
2. Pending Replace
3. Replace or Amend Reject

Supported Asset Classes

Equity

Request Body

  {
"orderId": "XXXXXX",
"price": 20,
"tif": 0,
"quantity": 3,
"orderType": "2"
}

Field Name   orderId required quantity optional orderType optional price optional tif optional amount N/A

Option

Request Body

   {
  "orderId": "XXXXXX",
  "price": 20,
  "tif": 0,
  "quantity": 3,
  "orderType": "2"
}

Field Name   orderId required quantity optional orderType optional price optional tif optional amount N/A

Fixed Income

Request Body

  {
"orderId": "XXXXXX",
"amount": 6000,
"price": 20,
"tif": 0,
"quantity": 3,
"orderType": "2"
}

Field Name   orderId required orderType optional price required tif optional amount required

Despite multiple amendments to the order, the execution list will always be displayed under the first order ID.

Request

application/json

Body

orderId stringrequired

order id

amount number

order amount

price number

order price

quantity number

order quantity

orderType integer

For Order types - Master Data > Get Exchange Order Types

tif integer

For Time in force. Master Data > Get Exchange Tif Types

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason stringrequired
orderReferenceId stringrequired
rejectCode string

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "orderReferenceId": "string",
  "rejectCode": "string"
}

example

{
  "status": "SUCCESS",
  "reason": "Order sent to OMS",
  "orderReferenceId": "a38d849845cf"
}

401

Unauthorized

application/json

Schema

Schema

timestamp string
status stringrequired
error stringrequired
message string
path string
rejectCode stringrequired

Example (from schema)

{
  "timestamp": "string",
  "status": "string",
  "error": "string",
  "message": "string",
  "path": "string",
  "rejectCode": "string"
}

Invalid Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Invalid Token",
  "path": "/api/v1.1/order/amend",
  "rejectCode": "1008"
}

Expired Token

{
  "timestamp": "2023-12-28T09:51:50.682Z",
  "status": "401",
  "error": "Unauthorized",
  "message": "Expired Token",
  "path": "/api/v1.1/order/amend",
  "rejectCode": "1007"
}

Loading...