Skip to main content

PLACE/MODIFY EQSIP ORDER APIโ€‹

This API enables placement and modification of EQSIP orders for authorized end users through a middleware-based integration.

If a new SIP is being created, a new EQSIP order will be registered. If an existing sip_id is provided, the corresponding EQSIP order can be modified.


๐Ÿ” Query Parametersโ€‹

ParameterTypeRequiredDescriptionExample
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 Schema : application/jsonโ€‹

FieldsTypeRequiredDescriptionExample/Enum
scrip_infoobjectyesScrip detailsSee below table
frequency_detailsobjectyesFrequency and scheduled info of the SIPSee below table
company namestringYesName of the company nameReliance 
ltpstringYesLast traded price of the scrip2850.75
cap pricestringYesCap price for SIP order2900.00
invested_bystringYesInvestment based on "QUANTITY" or "VALUE"VALUE
quantity_or_valueintegerYesQuantity or value based on the above selection5000
transaction_typestringYes"BUY" or "SELL"BUY
statusstringYesSIP status : "INITIAL"(new) or "PENDING" (modification)INITIAL
basket_samestringOptionalName of the SIP BasketTech Picks
sip_idstringOptionalSIP ID incase of modifying an existing SIPSIP7865562992

๐Ÿ“„Scrip info object fieldsโ€‹

FieldsTypeRequiredDescriptionExample/Enum
exchangestringyesExchange segmentsNSE_FO
scrip_tokenintegerOptionalUnique token ID of the scrip10125
symbolstringOptionalSymbol of the scripRELIANCE 
seriesstringOptionalSeries code (for equities)EQ
expiry_datestringOptionalExpiry date (yyyy-mm-dd) for F&O2025-06-05
strike_pricenumbernoStrike price (in paise), applicable for options255000
option_typestringno"CE" for Call, "PE" for PutPE

๐Ÿ“Frequency details object fieldsโ€‹

FieldsTypeRequiredDescriptionExample/ENUM
frequency_typestringYesSIP Frequency type.MONTHLY
frequency_daysstringYesDay(s) of week SIP will be placed.MONDAY
frequency_start_datestringYesStart date in format (dd-mm-yyyy)04-05-2025
frequency_specific_dateintegerOptionalSpecific date for monthlyย  SIP5
frequency_monthly_optionstringOptionalOnly "Date" is supported currentlyDATE
no_of_installmentsintegerYesTotal number of SIP installments12

๐Ÿ“˜ Frequency Type Valuesโ€‹

Value
DAILY
WEEKLY
FORTHNIGHTLY
MONTHLY

๐Ÿ“˜ Investment Mode Valuesโ€‹

ValueDescription
QUANTITYInvestment based on quantity
VALUEInvestment based on amount

๐Ÿ“˜ SIP Status Valuesโ€‹

Value
INITIAL
PENDING
RUNNING
COMPLETED
CANCELLED
STOPPED

๐ŸŸข Success Response - 200 OKโ€‹

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSIP placement/modification success message"EQSIP order processed successfully"

๐Ÿ“ Notesโ€‹

  • Used to create or modify an Equity SIP (EQSIP).
  • New SIP creation:
    • Do not send sip_id.
  • SIP modification:
    • Pass the existing sip_id.
  • Supports multiple SIP frequencies:
    • Daily
    • Weekly
    • Fortnightly
    • Monthly
  • invested_by determines whether SIP execution is based on:
    • Fixed Quantity
    • Fixed Investment Value
  • cap_price can be used to limit the execution price of SIP orders.
  • Only securities eligible for EQSIP should be used. Refer to the EQSIP Scrip Master API.