Order Management Api Errors

Error Format

All error responses contain an appropriate HTTP status code and have the following format:

{
    "errorCode": "InvalidRequestParameters",
    "message": "Bad request. Please review errors.",
    "errors": [
        {
            "errorCode": "InvalidLifetime",
            "fieldName": "Lifetime",
            "fieldValue": "123",
            "message": "Lifetime: '123' is invalid. Choose from: Date, EndOfDay, GoodTillCancel, FillAndKill, FillOrKill."
        }
    ]
}

  • errorCode: Top level errorCode. This unique code identifies the type of top level error it is.
  • message: Human readable message describing the error.
  • errors: An array of errors specific to invalid request parameters passed by the client. Note, this might be null.
  • error.errorCode: Parameter level errorCode. This unique code identifies the type of parameter error it is.
  • error.fieldName: The name of the field in the request.
  • error.fieldValue: The value passed in the field by the client.
  • error.message: Human readable message describing the error.

Top level errors

HTTP status code Error code Notes
400 RequestMissing The entire request is missing and needs to be set by the client.
400 InvalidRequestParameters The request contains invalid parameters. The errors with the invalid parameters will be in the errors array (see parameters level errors reference below for more details).
400 BrokenVettingRule The parameters used to create or amend an order broke a vetting rule. See message for more details.
400 ActionUnavailable The action requested against the order is unavailable. See message for more details.
400 ActionTemporarilyUnavailable The action requested against the order is temporarily unavailable. See message for more details.
403 AccessDenied Your client doesn't have access to this endpoint, try calling the "DELETE /sessions/application/v1" endpoint and try again, if still not working please contact support.
404 EndpointNotFound The endpoint called does not exist.
429 ApiCallsFrequencyExceeded The number of requests made to the API exceeds the maximum allowed for the period of time (eg: 30 calls per second).
429 ActiveApiCallsExceeded The number of active requests made to the API exceeds the maximum allowed. Active requests are requests that haven't returned yet and are still processing. Those also include subscriptions to updates.
429 MaxUpdatesQueuedExceeded Too many updates were queued since the last call. Call the update endpoint more often and or break down the request in ones returning less updates.
500 InternalServerError An unhandled error occured in the API. If it still happens after retrying please contact support with the request made.
503 ServiceUnavailable A temporary error occured in the API. If it still happens after retrying please contact support with the request made.

Parameter level errors

Error codeNotes
InvalidAccountCodeThe InvalidAccountCode parameter passed in the request is invalid. See message for more details.
InvalidAccountGroupThe InvalidAccountGroup parameter passed in the request is invalid. See message for more details.
InvalidAdvisorCodeThe InvalidAdvisorCode parameter passed in the request is invalid. See message for more details.
InvalidAdvisorGroupThe InvalidAdvisorGroup parameter passed in the request is invalid. See message for more details.
InvalidSecurityCodeThe InvalidSecurityCode parameter passed in the request is invalid. See message for more details.
InvalidSideThe InvalidSide parameter passed in the request is invalid. See message for more details.
InvalidOrderPriceThe InvalidOrderPrice parameter passed in the request is invalid. See message for more details.
InvalidOrderVolumeThe InvalidOrderVolume parameter passed in the request is invalid. See message for more details.
InvalidPricingInstructionThe InvalidPricingInstruction parameter passed in the request is invalid. See message for more details.
InvalidLifetimeThe InvalidLifetime parameter passed in the request is invalid. See message for more details.
InvalidExpiryDateTimeThe InvalidExpiryDateTime parameter passed in the request is invalid. See message for more details.
InvalidNotesThe InvalidNotes parameter passed in the request is invalid. See message for more details.
InvalidExchangeThe Exchange parameter passed in the request is invalid. See message for more details.
InvalidDestinationThe InvalidDestination parameter passed in the request is invalid. See message for more details.
InvalidFixedContingentOrderThe InvalidFixedContingentOrder parameter passed in the request is invalid. See message for more details.
InvalidTriggerPriceThe InvalidTriggerPrice parameter passed in the request is invalid. See message for more details.
InvalidTriggerPriceTypeThe InvalidTriggerPriceType parameter passed in the request is invalid. See message for more details.
InvalidTriggerConditionThe InvalidTriggerCondition parameter passed in the request is invalid. See message for more details.
InvalidOrderNumbersThe InvalidOrderNumbers parameter passed in the request is invalid. See message for more details.
InvalidOrderNumberThe InvalidOrderNumber parameter passed in the request is invalid. See message for more details.
InvalidDateTimeFromThe InvalidDateTimeFrom parameter passed in the request is invalid. See message for more details.
InvalidDateTimeToThe InvalidDateTimeTo parameter passed in the request is invalid. See message for more details.
InvalidUpdatesThe Updates header parameter passed in the request is invalid. See message for more details.
InvalidExchangeThe Exchange parameter passed in the request is invalid. See message for more details.
InvalidExchangeThe Exchange parameter passed in the request is invalid. See message for more details.
InvalidRequestIdsThe RequestIds parameter passed in the request is invalid. See message for more details.
RequestAlreadyProcessedThe RequestId used in the X-Request-ID header has already been processed by another request.
RequestAlreadyInUseThe RequestId used in the X-Request-ID header is already being used for a different updates subscription.
RequestNotFoundThe RequestId used in the X-Request-ID header to retrieve updates could not be found. You will need to restart the updates subscription flow.

Post creation order vetting errors

Order.StateDescription
Max order value limit breached
Concurrent bid/offer breached
ETO Orders Require DTR Authorisation
Warrant Orders Require DTR Authorisation
Chi-X Warrant Require DTR Authorisation
NSX Orders Require DTR Authorisation
Order value limit exceeded
Net day limit exceed
Gross day limit exceeded
Check Cash balance
Check Positions
(ETF) OrderRangePercentBreach - CHECK PRICE
(ETF) PriceRangeOrdersValuedLessThanValueBreach - CHECK PRICE
(ETF) PriceRangePercentFromBidAskBreach - CHECK PRICE
(ETF) PriceRangePercentFromLastBreach - CHECK PRICE
(ETF) PriceRangeValidPriceStepFromLastBreach - CHECK PRICE
(ETF)PriceRangeValidPriceStepBidAskBreach -CHECK PRICE
(OPEN) OrderRangePercentBreach
(OPEN) PriceRangeOrdersValuedLessThanValueBreach
(OPEN) PriceRangePercentFromBidAskBreach
(OPEN) PriceRangePercentFromLastValueBreach
(OPEN) PriceRangeValidPriceStepBidAskBreach
(OPEN) PriceRangeValidPriceStepFromLastBreach
(PRE-CLOSE) OrderRangePercentBreach
(PRE-CLOSE) PriceRangeOrdersValuedLessThanValueBreach
(PRE-CLOSE) PriceRangePercentFromBidAskBreach
(PRE-CLOSE) PriceRangePercentFromLastBreach
(PRE-CLOSE) PriceRangeValidPriceStepBidAskBreach
(PRE-CLOSE) PriceRangeValidPriceStepFromLastBreach
(PRE-OPEN) OrderRangePercentBreach
(PRE-OPEN) PriceRangeOrdersValuedLessThanValueBreach
(PRE-OPEN) PriceRangePercentFromBidAskBreach
(PRE-OPEN) PriceRangePercentFromLastBreach
(PRE-OPEN) PriceRangeValidPriceStepBidAskBreach
(PRE-OPEN) PriceRangeValidPriceStepFromLastBreach
(TRADING HALT) OrderRangePercentBreach
(TRADING HALT) PriceRangeOrdersValuedLessThanValueBreach
(TRADING HALT) PriceRangePercentFromBidAskBreach
(TRADING HALT) PriceRangePercentFromLastBreach
(TRADING HALT) PriceRangeValidPriceStepBidAskBreach
(TRADING HALT) PriceRangeValidPriceStepFromLastBreach
Out of Market hours. Your order will be authorised the next business day before 10am