Skip to main content

Position Conversion Inquiry

This API retrieves the actual OMS status of a position conversion request submitted via the Position Conversion API.

Prerequisite: You must first call the Position Conversion API to initiate a conversion and obtain an orderId. That orderId is the required input for this API.

🔍Query Parameters

FieldTypeRequiredDescriptionExample/ENUM
orderIDstringYesThe orderId returned in the data object of the Position Conversion API response"PCV1234567"

🔑Header Parameters

HeaderTypeRequiredDescriptionExample/ENUM
Content-TypestringYesMedia Type of the request bodyapplication/json
AuthorizationstringYesBearer token for authenticationBearer access_token
x-api-keystringYesAPI key provided for authorizationx-api-key

🟢Success Response - 200 OK

FieldTypeDescriptionExample
statusstringIndicates the status of the API call"success"
codestringResponse code for the request"s-101"
messagestringMessage conveying the response info"Conversion Successful"

🔴 Error / Rejection Response - 200 OK

The OMS may accept the API call but reject the conversion itself. In this case the response still returns HTTP 200 but with status: "error" and a pipe-separated message containing the orderId and the rejection reason.

FieldTypeDescriptionExample
statusstringIndicates the conversion was rejected by the OMS"error"
codestringResponse code"s-101"
messagestringPipe-separated string in the format "orderId|rejection reason" returned directly by the OMS"NWSYF00005F5|Free Qty not available for Position Conversion of APITEST"

Common rejection reasons include:

  • Free Qty not available for Position Conversion — The quantity requested for conversion exceeds the available free (unsettled) quantity for that position.
  • Margin shortfall — Insufficient margin to hold the position under the new product type.

Always parse the message field by splitting on | to extract the rejection reason for display or logging.