Skip to main content

Sync Position Conversion

🚀 Sync Position Conversion Request​

FieldDetails
API NameSyncPositionConversionOrders
URL Format<protocol>://<domain name:port>/<VirtualDir>/<URL>
Example URLhttps://localhost:8080/OTPA/V1/SyncPositionConverion
DescriptionThis request retrieves all Position Conversion orders available in the system. When the server receives this request, it sends state‑based Position Conversion Order information messages. The request must include the jToken received from the Authentication API.

📖 Sync Position Conversion Request Parameters​

ParameterData TypeDescription
jMessageTypevarchar(15)Must be sent as SYNC_POS_CON
jManagerIDvarchar(50)Manager Identification Number
jCustomerIdvarchar(50)Customer ID assigned to the user
jExchangeintExchange identifier
jTokenvarchar(512)Authentication token received from Authentication API
jEntrySequenceNumberint64Last received sequence number (default is 0 if not provided)
jRequestIDvarchar(255)Echo‑back field

Example Sync Position Conversion Request​

{
"jMessageType": "SYNC_POS_CONV",
"jManagerID": "<MANAGER1>",
"jCustomerId": "<MEMBER>",
"jToken": "<Token received in the Authentication Response>",
"jEntrySequenceNumber": "<max sequence no>",
"jRequestID": "<Echo back field>"
}

📦 Sync Position Conversion Response​

The response contains the following parameters:

ParameterData TypeDescription
jManagerIdvarchar(50)User ID assigned to the user
jCustomerIdvarchar(50)Customer ID assigned to the user
jLastSyncedPacketintIndicates if this is the last packet (1 = last packet)
jNoOfRecordsintNumber of Position Conversion records
jOrderMessagePosition Conversion Detail Structure (array)Array of Position Conversion messages (size = jNoOfRecords)
jRequestIDvarchar(255)Echo back field
jResponseIDvarchar(255)System‑generated alphanumeric ID

📝 Sync Position Conversion Detail Structure​

Each entry inside jOrderMessage contains:

Parameter (Key)Data TypeDescription
Order NumberintNA
Cli Order NumberintPosition Conversion Serial Number
Exchangevarchar(10)Exchange
Scrip TokenintScrip token
SymbolfloatExchange‑provided security scrip name
Seriesvarchar(3)Exchange‑provided security series
InstrumentNamevarchar(20)Instrument name. Valid values:
• Equity = blank
• Future Index = FUTIDX
• Interest Rate Future = FUTINT
• Future Stock = FUTSTK
• Option Index = OPTIDX
• Option Stock = OPTSTK
• MCX/NCDEX Futures = FUTCOM
• MCX Spot = COM
• NCDEX Spot = COMDTY
• NSE Currency Future = FUTCUR, FUTIRD, FUTIRT, OPTCUR
• NSE Currency Spot = INDEX, UNDCUR, UNDIRD, UNDIRT
Expiry Datevarchar(10)Expiry date (ddMMMyyyy, e.g., 24JUN2004). Applicable for F&O only; blank otherwise.
Strike PricefloatExchange‑provided strike price (in rupees). Applicable for options only; otherwise -1.
Option Typevarchar(2)Option type. Applicable for options only; blank otherwise.
Buy SellintBuy/Sell flag:
• 1 → Buy
• 2 → Sell
Order Original QtyintOriginal order quantity
Pending QtyintNA
TradedQTYintNA
DQintNA
Order PricefloatNA
Trigger PricefloatNA
Order Typevarchar(10)Order type
Order Statusvarchar(15)Order status
Reasonvarchar(300)Rejection reason
Order Validityvarchar(100)NA
Pro/CliintParticipant type:
• 1 → CLI
• 2 → PRO
User IDvarchar(10)NA
DealerCodevarchar(5)Unique user identification code
Part Codevarchar(12)NA
Order Entry Timevarchar(10)NA
Last Modified Timevarchar(10)Order last modified timestamp (e.g., 15Jun2018 15.25.15)
Aliasvarchar(5)Alias ID; blank if not applicable
Productvarchar(5)Position Conversion product type
Initiated Byvarchar(25)Application that initiated the request (e.g., ADMIN, NET)
Modified Byvarchar(25)Application that modified the request
Initiated By User Idvarchar(10)User ID that initiated the request
Modified By User Idvarchar(10)User ID that modified the request
Leg IndicatorintNA
LocationIDvarchar(5)Location Identifier (PIN + NSECTCLBRANCH ID + NSECTCLID + ALGO FLAG + VENDOR CODE)
User Remarksvarchar(50)NA
Miscvarchar(50)NA
SpreadFlagintNA
Spread PricefloatNA
AMO Order IDvarchar(50)NA
SequenceNoint64Incremental sequence number
ManagerIdintManager ID
DaysintNA
UniqueCodevarchar(12)Alphanumeric value with special characters

Example Response​

{
"jData": {
"ManagerID": "KOTAL_10.0.0.1",
"CustomerId": "KOTAK",
"NoOfRecords": 6,
"OrderDetail": [
{ "MessageCode": 2000, "OrderNumber": 1, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 2, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 3, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 4, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 5, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 6, "...": "..." }
]
}
}