OpenAPI
Open API Learn Tutorial Reference Docs Explorer Apps Updates Get 24 Hour Token Sign in
Other Products FIX Trading API Client Management Systems API End-of-Day File Transfers Trade Event Notification System OpenAPI for Excel

Margin Call Events

Message to indicate some event related to client margin.

Additional Fields

NameTypeDescription

MarginCallAction

MarginCallAction

Describes the action associated with this margin call. See below.

MarginCallLevel

Int

The margin percentage level, which was breached. NOTE: The clients actual margin at the time of receiving this message may deviate slightly from the threshold level.

If the MarginCallAction is "LevelDrop", there are two situations where the value of MarginLevel may be 0 (or null).

  • Scenario 1: If the margin level has dropped under the last percentage defined in the margin call profile, then the margin call level will be equal to 0, in this case the MarginCallLevel field will not be included in the Margin Call notification. 
  • Scenario 2: In case of account funding where the account balance was negative, margin call level call level will be equal to 0, in this case the MarginCallLevel field will not be included in the Margin Call notification.
MarginCallActionTypestring

A string defining the type of margin call initiated. Currently the following are defined:

(ActionStopOut, ActionAEPopUp, ActionAEEmail, ActionCSPopUp, ActionClientEmail,ActionAEStopOut,ActionReinstateEmail,ActionReinstatePopUp,ActionLevelDrop).

The value returned in MarginCallActionType matches the "Action Type" set for a particular margin call definition on Saxo's system.

MarginCallActionSubTypestringA string defining the sub-type of SotpOut margin call. Currently the following are defined:
(MarginStopOut, OptionsCloseOut, MarginLendingStopOut).
MarginEntityTypestringA string defining at which level margin call happened. Following are the possible values:
(ClientLevel, AccountGroup, Account)
TimeOnMarginTimeSpanSpecifies time by which client has been on Margin. Format is "hh:mm:ss".


Sample Message

An example of a margin call event message:

{
  "ReferenceId": "C_542",
  "Timestamp": "2018-07-12T06:31:16.970252Z",
  "Data": [
    {
      "AccountId": "117821INET",
      "ActivityTime": "2018-07-12T06:31:16.656555Z",
      "ActivityType": "MarginCalls",
      "ClientId": "2922773",       
      "MarginCallAction": "MarginCall",
      "MarginCallActionType": "StopOut",
      "MarginCallActionSubType": "MarginStopOut",
	  "MarginEntityType": "ClientLevel"
      "MarginCallLevel": 90,
      "TimeOnMargin" : "02:12:05"
      "SequenceId": "279837"
    }
  ]
}


MarginCallAction

The type of event can be found in the MarginCallAction field. Possible values are:

ValueDescription
MarginCallThe client is requested to restore the necessary margin required.
ReinstateThe system has restored the necessary margin required.
StopOutThe client has been forcefully stopped out to restore the necessary margin required.
LevelDrop

Margin level dropped, The client has restored the necessary margin level required, according to the margin call profile defined. This margin call action will appear if the client margin level dropped under the defined margin levels percentage as set in the margin call profile.

This is normally not communicated to the client.


Comments about Margin Calls

The levels at which margin calls and stop outs are triggered are defined in a margin profile, which is configured by Saxo's staff. The margin call profile may also specify that a client should be reminded at regular intervals, if the margin level remains above a certain threshold for a prolonged period of time.