Cancel GTT Order Beta

This API allows the cancellation of an existing Good Till Trigger (GTT) order that has not yet been triggered. Once canceled, all associated legs will be canceled and will no longer be monitored for execution, and all related trigger conditions will be discarded.

Header Parameters

Name	Required	Type	Description
Authorization	true	string	Requires the format Bearer access_token where access_token is obtained from the Token API.
Content-Type	true	string	Indicates the media type of the resource, set as application/json.
Accept	true	string	Defines the content format the client expects, which should be set to application/json.

Request Body

{
  "gtt_order_id": "GTT-221130000253265"
}

Name	Required	Type	Description
gtt_order_id	true	string	The order ID for which the order must be cancelled.

Responses

• 2XX
• 4XX

---

Response Body

{
  "status": "success",
  "data": {
    "gtt_order_ids": ["GTT-CU25280200018007"]
  },
  "metadata": {
    "latency": 65
  }
}

Name	Type	Description
status	string	A string indicating the outcome of the request. Possible values: success, error
data	object	Response data for cancel order request.
data.gtt_order_id	string	The Order ID submitted for cancellation.
metadata	object	Metadata information.
metadata.latency	integer	The overall time taken by API platform to process the request, measured in milliseconds.

Error Codes

Error Code	Description
UDAPI1134	gtt_order_id is required - The request must include a valid GTT order ID.
UDAPI1135	GTT order ID must start with 'GTT-' - The order ID should follow the required format.

Examples

A comprehensive set of examples is provided to illustrate various use cases and implementation scenarios for this API. To view detailed examples and access sample code, please refer to: API Examples.

Loading...