PAUSE/RESUME/CANCEL EQ SIP ORDER
This API enables pausing, resuming, and cancellation of existing EQ SIP orders for authorized end users through a middleware-based integration.
The action performed depends on the current SIP status and request context.
🔗 Path Parameters
| Parameter | Type | Required | Description | Example |
|---|
| sipid | string | Yes | SIP Identifier | "SI1411220001" |
| orderStatus | string | Yes | Current status of the SIP | "PENDING" |
| scripName | string | Yes | Scrip symbol associated with the SIP | "SBIN" |
| transactionType | string | Yes | SIP transaction type | "BUY" |
| investmentType | string | Yes | SIP investment type | "QUANTITY" |
| qtyOrVal | integer | Yes | Quantity or value configured for SIP execution | 1 |
🔍 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}} |
🟢 Success Response - 200 OK
Content-Type: application/json
| Field | Type | Description | Example |
|---|
| status | string | Status of API call | "success" |
| code | string | Response code | "200" |
| message | string | Status message indicating successful pause, resume, or cancellation of the SIP | "EQ SIP order paused successfully" |
📝 Notes
- Used to manage an existing EQ SIP order.
- Supports the following actions:
- Pause SIP
- Resume SIP
- Cancel SIP
- Cancellation is typically irreversible, whereas paused SIPs may be resumed if supported by the system.
- Use the EQSIP Order Details API to retrieve the latest SIP information before performing an action.