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โ
| Parameter | Type | Required | Description | Example |
|---|
| userId | string | Yes | User ID (UCC) | "{{user_id}}" |
| Header | Type | Description | Example |
|---|
| Content-Type | string | Request payload format | application/json |
| Authorization | string | Access token for authenticated requests | {{access_token}} |
| x-api-key | string | API key used to authorize request | {{x-api-key}} |
๐ฆRequest Body Schema : application/jsonโ
| Fields | Type | Required | Description | Example/Enum |
|---|
| scrip_info | object | yes | Scrip details | See below table |
| frequency_details | object | yes | Frequency and scheduled info of the SIP | See below table |
| company name | string | Yes | Name of the company name | Reliance  |
| ltp | string | Yes | Last traded price of the scrip | 2850.75 |
| cap price | string | Yes | Cap price for SIP order | 2900.00 |
| invested_by | string | Yes | Investment based on "QUANTITY" or "VALUE" | VALUE |
| quantity_or_value | integer | Yes | Quantity or value based on the above selection | 5000 |
| transaction_type | string | Yes | "BUY" or "SELL" | BUY |
| status | string | Yes | SIP status : "INITIAL"(new) or "PENDING" (modification) | INITIAL |
| basket_same | string | Optional | Name of the SIP Basket | Tech Picks |
| sip_id | string | Optional | SIP ID incase of modifying an existing SIP | SIP7865562992 |
๐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 scrip | 10125 |
| symbol | string | Optional | Symbol of the scrip | RELIANCE  |
| series | string | Optional | Series code (for equities) | EQ |
| expiry_date | string | Optional | Expiry date (yyyy-mm-dd) for F&O | 2025-06-05 |
| strike_price | number | no | Strike price (in paise), applicable for options | 255000 |
| option_type | string | no | "CE" for Call, "PE" for Put | PE |
๐Frequency details object fieldsโ
| Fields | Type | Required | Description | Example/ENUM |
|---|
| frequency_type | string | Yes | SIP Frequency type. | MONTHLY |
| frequency_days | string | Yes | Day(s) of week SIP will be placed. | MONDAY |
| frequency_start_date | string | Yes | Start date in format (dd-mm-yyyy) | 04-05-2025 |
| frequency_specific_date | integer | Optional | Specific date for monthlyย SIP | 5 |
| frequency_monthly_option | string | Optional | Only "Date" is supported currently | DATE |
| no_of_installments | integer | Yes | Total number of SIP installments | 12 |
๐ Frequency Type Valuesโ
| Value |
|---|
| DAILY |
| WEEKLY |
| FORTHNIGHTLY |
| MONTHLY |
๐ Investment Mode Valuesโ
| Value | Description |
|---|
| QUANTITY | Investment based on quantity |
| VALUE | Investment based on amount |
๐ SIP Status Valuesโ
| Value |
|---|
| INITIAL |
| PENDING |
| RUNNING |
| COMPLETED |
| CANCELLED |
| STOPPED |
๐ข Success Response - 200 OKโ
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "s-101" |
| message | string | SIP placement/modification success message | "EQSIP order processed successfully" |
๐ Notesโ
- Used to create or modify an Equity SIP (EQSIP).
- New SIP creation:
- 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.