Skip to main content

CANCEL ALL EQ SIP ORDER

This API enables bulk cancellation of EQ SIP orders for authorized end users through a middleware-based integration.

Bulk cancellation can be performed by passing the list of SIP orders that need to be cancelled.

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
product_sourcestringNoSource of the request"ADMINAPI"
userIdstringYesUser ID (UCC)"{{user_id}}"

🔑 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}}

📑 Request Body Parameters

FieldTypeRequiredDescription
flagbooleanYesProcessing flag for bulk cancellation
orderarrayYesList of EQ SIP orders to be cancelled

📦 Order Object Fields

FieldTypeRequiredDescriptionExample
sip_idstringYesSystem-generated unique SIP order identifier"SI1411220001"
statusstringYesCurrent status of the SIP order"RUNNING"
symbolstringYesSymbol code provided in the exchange scrip master file"SBIN"
transaction_typestringYesBuy or Sell transaction type"BUY"
investment_typestringYesInvestment mode"QUANTITY"
invested_qty_or_valintegerYesQuantity or investment value configured for the SIP1

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringBulk cancellation status message"EQ SIP orders processed successfully"
dataarrayList of SIP cancellation resultsRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
sip_idstringSIP identifier"SI1411220001"
symbolstringTrading symbol"SBIN"
statusstringSIP cancellation status"CANCELLED"
messagestringSIP-specific response message"SIP cancelled successfully"

📝 Notes

  • Used to cancel multiple EQ SIP orders in a single request.
  • Each SIP order is processed independently and returns its own status and response message.