Amend Order

POST 
/v1.2/order/amend

Order status will change according to following sequence.

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

Supported Order Types

Equity

Request Body

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

Field Name   orderId optional orderReferenceId optional quantity optional orderType optional price optional

Field Name   tif optional stopPrice optional trailByValue optional trailType optional

Option

Request Body

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

Field Name   orderId optional orderReferenceId optional quantity optional orderType optional

Field Name   price optional tif optional stopPrice optional

Fixed Income

Request Body

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

Field Name   orderId optional orderReferenceId optional quantity optional

Field Name   orderType optional tif optional price required

Fund

Request Body

{
 "orderId": "XXXXXX",
 "orderReferenceId": "XXXXXXX",
 "investmentId": "YYYYYY",
 "externalOrderId": "ZZZZZZ",
 "amount": 10000
}

Field Name   orderId optional orderReferenceId optional

Field Name   investmentId optional amount required

Spot

Request Body

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

Field Name   orderId optional orderReferenceId optional quantity optional

Field Name   orderType optional price optional tif optional

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

Request

Header Parameters

Throttle-Key string

application/json

Body

orderId string

order id

orderReferenceId string

order id

investmentId string

investment id

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

amount number

Invetment amount Required for top-up fund order

stopPrice number

only applicable for Trailing stop orders. only support in ASIA region for equity and option orders.

trailByValue number

only applicable for Trailing stop orders. only support in ASIA region for equity.

trailType string

Possible values: [TYPE:%, TYPE:$]

only applicable for Trailing stop orders. only support in ASIA region for equity.

Responses

200

OK

application/json

Schema

Schema

status stringrequired
reason stringrequired
orderReferenceId stringrequired

Example (from schema)

{
  "status": "string",
  "reason": "string",
  "orderReferenceId": "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.2/order/amend",
  "rejectCode": "1008"
}

Expired Token

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

Loading...