CANCEL MULTILEG/SPREAD ORDER

This API enables cancellation of existing Multileg and Spread Orders for authorized end users through a middleware-based integration.

Only eligible Multileg or Spread Orders can be cancelled.

🔗 Path Parameters

Parameter	Type	Required	Description	Example
order_flag	string	Yes	Order action to be performed	"cancel"
gateway_order_no	string	Yes	Gateway Order Number of the Multileg/Spread Order	"AAAEE00005"

🔍 Query Parameters

Parameter	Type	Required	Description	Example
userId	string	Yes	User ID (UCC)	"{{user_id}}"

🔑 Header Parameters

Header	Type	Description	Example
Content-Type	string	Request payload format	application/json
Authorization	string	Access token for authenticated requests	{{access_token}}
x-api-key	string	API key used to authorize request	{{x-api-key}}

📦Request Body Schema: application/json

Fields	Type	Required	Description	Example/ENUM
type	string	yes	Type of multileg order	"SPREAD" "2L" "3L"
order_type	string	yes	Type of Order Supported : "RL" , "RL-MKT"	"RL"
validity	string	yes	Order Validity. Usually: "IOC"	"IOC"
leg_details	array of object	yes	Details of each leg of the order	See below table

📘Leg Details object fields

Fields	Type	Required	Description	Example/Enum
leg_no	integer	Yes	Identifier of the leg	1
scrip_info	object	yes	Instrument details	See below table
transactional_type	string	yes	Buy or sell	SELL
quantity	number	yes	Quantity for this leg	75
price	string	Yes	Price of the leg	"250.50"
others	object	Yes	Lot size and price tick details	See below table

📑Scrip info object fields

Fields	Type	Required	Description	Example/Enum
exchange	string	yes	Exchange segments	NSE_FO
scrip_token	integer	Optional	Unique token id of the instrument	123456
symbol	string	Optional	Symbol of the scrip	RELIANCE 
series	string	Optional	Series (for equities)	EQ
expiry_date	string	Optional	Expiry date (yyyy-mm-dd) for F&O	2025-06-05
strike_price	number	Optional	Strike price in paise (for options)	255000
option_type	string	Optional	option type: "CE" call or "PE" put	PE

📑Others object fields

Fields	Type	Required	Description	Example/Enum
market_lot	integer	Yes	Lot size	75
price_tick	number	Yes	Price movement increment	0.05
decimal_loc	number	Yes	Decimal locator for precision	2

🟢Success Response - 200 OK

Fields	Type	Description	Example/Enum
Status	string	Status of API Call	"success"
Code	string	Response code	"s-101"
message	string	Confirmation Message	"Order submitted for cancellation"
data	object	Contain additional details	See below table

📄Data Object Info Field

Field	Type	Description	Example/Enum
order id	string	Internal order ID assigned by system	"SPRD12345"
gateway_order_no	string	Gateway order reference number	"04567435