Trading:AuthoriseOrder

Requests to authorise an Order Request awaiting authorisation.

Successful completion of this action does not mean your Order Request has been authorised or rejected, only that the request has been acknowledged.

When authorising a placement an Order, a temporary Order ID will be allocated, and may change once it reaches the market.

Controller: Trading
Topic: AuthoriseOrder
Action: Publish
Permissions: Zenith/Authorise

Request

Name	Type	Expect	Description
Account	String	Always	The Account that owns the Order request.
Flags	Array	Optional	An array of string flags. See Appendix F: Order Flags for more information.
OrderID	String	Always	The unique identifier of the Order to authorise.
RequestID	String	Optional	A string to uniquely (within this Account) identify this request. If omitted, a random 22-character alphanumeric string will be generated by the server.
Authorise	Boolean	Always	True to authorise the request, False to reject.
Reason	String	Optional	An optional text reason to record against the authorisation or rejection.

Response

Name	Type	Expect	Description
Result	String	Always	The result of the operation. One of the following values: Success – Request successful. Incomplete – Required fields are missing. Invalid – The supplied fields are invalid. Rejected – The order was rejected.
RequestID	String	Always	A string to uniquely (within this Account) identify this request.
Order	Object	Optional	If the request was successful, supplies the Order state after this request was acknowledged
Errors	Array	Optional	If the request failed, supplies an array of string codes identifying the errors encountered. See Appendix E: Order Error Codes for more information
EstimatedBrokerage	Decimal	Optional	If able to be calculated, provides the estimated brokerage this Order would incur
EstimatedTax	Decimal	Optional	If able to be calculated, provides the estimated tax this Order would incur
EstimatedValue	Decimal	Optional	If able to be calculated, provides the estimated value of this Order, not including Brokerage or Tax (ie: Net Consideration)

Example

Send:

{
  "Controller":"Trading",
  "Topic":"AuthoriseOrder",
  "TransactionID":1,
  "Data":
  {
    "Account":"1234[Demo]",
    "OrderID":"00000000-0000-0000-CDEF-123456789ABC",
    "Authorise":true,
    "Reason":"OK"
  }
}

Receive:

{
  "Controller":"Trading",
  "Topic":"AuthoriseOrder",
  "TransactionID":1,
  "Data":
  {
    "Result":"Success",
    "Order":
    {
      "ID":"00000000-0000-0000-CDEF-123456789ABC",
      ...
    },
    "EstimatedBrokerage":10.00,
    "EstimatedValue":1000.000
  }
}