Skip to main content

ORDER MESSAGES

This API retrieves order-related messages and notifications for the user, including order status updates, exchange responses, rejections, modifications, and other order lifecycle events.

🔗 Path Parameters

ParameterTypeRequiredDescriptionExample
tenantidstringYesUnique id provided for the tenant by SIPL"tenant001"

🔍 Query Parameters

ParameterTypeRequiredDescriptionExample
userIdstringYesUser ID (UCC)"{{user_id}}"
pageNointegerNoPage number for pagination1
pageSizeintegerNoNumber of records per page10

🔑 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}}

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescription
statusbooleanStatus of API call
resultarrayList of order messages

📦 Order Message Fields

FieldTypeDescriptionExample
timestringTime of the order message"10:15:30"
datestringDate of the order message"2026-06-25"
cliOrdNostringClient Order Number"240625000123"
msgstringOrder-related message"Order executed successfully"
mktSegIdintegerMarket Segment ID1