Skip to main content

CANCEL COVER ORDER​

This API enables cancellation of Cover Orders for authorized end users through a middleware-based integration.

Only eligible pending Cover Orders can be cancelled.

🔗 Path Parameters​

ParameterTypeRequiredDescriptionExample
exchangestringYesExchange segment in which the Cover Order is placed"NSE_EQ"
order_idstringYesOrder ID of the Cover Order to be cancelled"NXWBB00003"

🔍 Query Parameters​

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
product_sourcestringNoSource of the order. Allowed values: WEBAPI, MOBILEAPI (case-insensitive). Any other value is ignored without an error."MOBILEAPI"

🔑 Header Parameters​

HeaderTypeDescriptionExample
Content-TypestringRequest payload formatapplication/json
AuthorizationstringAccess token for authenticated requests{{access_token}}
x-api-keystringAPI key used to authorize request{{x-api-key}}

🟢 Success Response - 200 OK​

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringCover Order cancellation success message"Cover order cancelled successfully"
dataobjectOrder response detailsRefer Data Object Fields

📦 Data Object Fields​

FieldTypeDescriptionExample
orderIdstringSystem-generated order identification number"NXWBB00003"