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
| Parameter | Type | Required | Description | Example |
|---|
| product_source | string | No | Source of the request | "ADMINAPI" |
| 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 Parameters
| Field | Type | Required | Description |
|---|
| flag | boolean | Yes | Processing flag for bulk cancellation |
| order | array | Yes | List of EQ SIP orders to be cancelled |
📦 Order Object Fields
| Field | Type | Required | Description | Example |
|---|
| sip_id | string | Yes | System-generated unique SIP order identifier | "SI1411220001" |
| status | string | Yes | Current status of the SIP order | "RUNNING" |
| symbol | string | Yes | Symbol code provided in the exchange scrip master file | "SBIN" |
| transaction_type | string | Yes | Buy or Sell transaction type | "BUY" |
| investment_type | string | Yes | Investment mode | "QUANTITY" |
| invested_qty_or_val | integer | Yes | Quantity or investment value configured for the SIP | 1 |
🟢 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 | Bulk cancellation status message | "EQ SIP orders processed successfully" |
| data | array | List of SIP cancellation results | Refer Data Object Fields |
📦 Data Object Fields
| Field | Type | Description | Example |
|---|
| sip_id | string | SIP identifier | "SI1411220001" |
| symbol | string | Trading symbol | "SBIN" |
| status | string | SIP cancellation status | "CANCELLED" |
| message | string | SIP-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.