Skip to main content

Cancel Multileg/Spread Order

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

🛣️Path Parameters

FieldsTypeRequiredDescriptionExample/Enum
order_flagstringYesAction to be performed (should be cancel)cancel
gateway_order_nointegeryesGateway order number of the mutli-leg order0409005

🔑Header Parameters

FieldsTypeRequiredDescriptionExample/Enum
AuthorizationstringyesBearer token for authenticationaccess_token
x-api-keystringYesAPI key provided by bearerx-api-key
Content_typestringyesType of content being sentapplication/json

📦Request Body Schema: application/json

FieldsTypeRequiredDescriptionExample/ENUM
typestringyesType of multileg order"SPREAD" "2L" "3L"
order_typestringyesType of Order Supported : "RL" , "RL-MKT""RL"
validitystringyesOrder Validity. Ususally: "IOC""IOC"
leg_detailsarray of objectyesDetails of each leg of the orderSee below table

📘Leg Details object fields

FieldsTypeRequiredDescriptionExample/Enum
leg_nointegerYesIdentifieer of the leg1
scrip_infoobjectyesInstrument detailsSee below table
trasactional_typestringyesBuy or sellSELL
quantitynumberyesQuantity for this leg75
pricestringYesPrice of the leg"250.50"
ordersobjectYesLot size and prize tick detailsSee below tabe

📑Scrip info object fields

FieldsTypeRequiredDescriptionExample/Enum
exchangestringyesExchange segmentsNSE_FO
scrip_tokenintegerOptionalUnique token id of the instrument123456
symbolstringOptionalSymbol of the scripRELIANCE 
seriesstringOptionalSeries (for equities)EQ
expiry_datestringOptionalExpiry date (yyyy-mm-dd) for F&O2025-06-05
strike_pricenumberOptionalStrike price in paise (for options)255000
option_typestringOptionaloption type: "CE" call or "PE" putPE

📑Others object fields

FieldsTypeRequiredDescriptionExample/Enum
market_lotintegerYesLotsize75
price_ticknumberYesPrice movement increment0.05
decimal_locnumberYesDecimal locator for precision2

🟢Success Response - 200 OK

FieldsTypeDescriptionExample/Enum
StatusstringStatus of API Call"success"
CodestringResponse code"s-101"
messagestringConfirmation Message"Order submitted for cancellation"
dataobjectContain additional detailsSee below table

📄Data Object Info Field

FieldTypeDescriptionExample/Enum
order idstringInternal order ID assigned by system"SPRD12345"
gateway_order_nostringGateway order reference number"04567435
put/transactional/v1/orders/multileg/{order_flag}/{gateway_order_no}