Cancel Multileg/Spread Order

This API cancels an existing multileg/spread order that is pending in order book

🛣️Path Parameters

Fields	Type	Required	Description	Example/Enum
order_flag	string	Yes	Action to be performed (should be cancel)	cancel
gateway_order_no	integer	yes	Gateway order number of the multi-leg order	0409005

🔑Header Parameters

Fields	Type	Required	Description	Example/Enum
Authorization	string	yes	Bearer token for authentication	access_token
x-api-key	string	Yes	API key provided by bearer	x-api-key
Content_type	string	yes	Type of content being sent	application/json

Parameter	Type	Required	Description	Example
order_flag	string	Yes	Action flag; must be "cancel" for cancellation	"cancel"
gateway_order_no	integer	Yes	Gateway order number returned in the Place Multileg Order response	032800024

🔑 Header Parameters

Header	Type	Required	Description	Example
Authorization	string	Yes	Bearer token for authenticated requests	{{access_token}}
x-api-key	string	Yes	API key used to authorize the request	{{x-api-key}}
Content-Type	string	Yes	Specifies the media type of the request	application/json

📑 Request Body Parameters

Same structure as Place Multileg/Spread Order — pass all leg details with the same leg data used when the order was placed.

Field	Type	Required	Description	Example / Enum
type	string	Yes	Leg type indicator matching the original order	"2L", "3L", "SPREAD"
validity	string	Yes	Must be "IOC"	"IOC"
prot_perc	string	No	Protection percentage; leave empty	""
order_time	integer	No	Reserved field; send 0	0
order_identifier	string	No	Original order identifier	"1357470777"
leg_details	array	Yes	Array of leg objects matching the original order	Refer below

📘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

Important Note

gateway_order_no must be taken from the Place Multileg Order response. It is not the same as orderId.