Executes an Order

Accepts a JSON or XML body representing the Order to be placed.

Sample Request Body (XML) :

<ExecuteOrder>
    <Instruments>
        <Option InstrumentId="Option" CallOrPut="Call" IsCashSettled="false" Delta="1" ContractSize="1" >
            <Component InstrumentId="Equity" />
        </Option>
        <Equity InstrumentId="Equity" InstrumentName="Hargreaves Lansdown Plc" IssuerId="549300C116EOWV835768" IssuerName="Hargreaves Lansdown Plc" ISIN="GB00B1VZ0M25" InstrumentCurrency="GBP" CountryOfIncorporation="GB" CountryOfIssue="GB" LEI="549300C116EOWV835768" Market="XASX" MarketsListedIn="XASX,XJSE,XLON" Price="54.2" VotesPerShare="1" ClassSharesOutstanding="10000" TotalSharesOutstanding="10000" TotalSharesInTreasury="0" TotalVotingShares="10000" TotalVotingSharesInTreasury="0" TotalVotingRights="10000" TotalVotingRightsInTreasury="0" IsWhenIssued="False"/>
    </Instruments>
    <Asset SFTType="Normal" HoldingType="Direct" AssetId="GB00B1VZ0M25" AssetName="Hargreaves Lansdown Plc" InstrumentId="Option" Quantity="10" MarketValueInInstrumentCurrency="21321" />
    <PortfolioId>6b97b9bc-b8d1-459c-af01-af9700a622c6</PortfolioId>
    <Timestamp>2023-03-15T17:29:00Z</Timestamp>
</ExecuteOrder>
        

Sample Request Body (JSON) :

{
    "Instruments": [
         {
             "Properties": {
                 "InstrumentId": "O_E_Option",
                 "InstrumentName": "O_E_Option",
                 "AssetClass": "Option",
                 "CallOrPut": "Put",
                 "IsCashSettled": false,
                 "Delta": 1,
                 "ContractSize": 1,
                 "IsGBCountryOfRCARegulatedMarkets": true
             },
            "Components": [
                {
                    "InstrumentId": "O_E_Equity"
                }
            ]
         },
         {
             "Properties": {
                 "Isin": "GB000001",
                 "InstrumentId": "O_E_Equity",
                 "InstrumentName": "O_E_Equity",
                 "AssetClass": "Equity",
                 "IssuerId": "Issuer1",
                 "IssuerName": "Issuer1",
                 "InstrumentCurrency": "GBP",
                 "CountryOfIncorporation": "GB",
                 "CountryOfIssue": "GB",
                 "LEI": "549300C116EOWV835768",
                 "Market": "XLON",
                 "MarketsListedIn": "XLON, XXXX",
                 "Price": 54.2,
                 "VotesPerShare": 1,
                 "ClassSharesOutstanding": 1000,
                 "TotalSharesOutstanding": 1000,
                 "TotalSharesInTreasury": 0,
                 "TotalVotingShares": 1000,
                 "TotalVotingSharesInTreasury": 0,
                 "TotalVotingRights": 1000,
                 "TotalVotingRightsInTreasury": 0,
                 "IsWhenIssued": false
             }
         }
    ],
    "Asset": {
        "Properties": {
            "Quantity": 10,
            "SFTType": "Normal",
            "HoldingType": "Direct",
            "AssetId": "Asset_ID",
            "AssetName": "My Asset",
            "InstrumentId": "O_E_Option",
            "MarketValueInInstrumentCurrency": 21321
        }
    },
    "PortfolioId": "11",
    "OrderType": "Buy",
    "Timestamp": "2023-03-23"
}
        

Sample Response (Passed) :

{
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "passed": true,
    "rulesFailed": [],
    "totalRulesChecked": [
        {
            "portfolioId": "11",
            "totalRulesChecked": 31
        },
        {
            "portfolioId": "FAAM",
            "totalRulesChecked": 42
        }
    ],
    "unknownSummary": {}
}
        

Sample Response (Failed) :

{
    "orderId": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
    "passed": failed,
    "rulesFailed": [
    {
        "ruleId": 1265,
        "ruleVersionId": "67cd0720-af4c-4748-990a-bae24af97452",
        "results": [
        {
            "passed": false,
            "groupKey": "2138002P5RNKC5W2JZ46#GB00BLGZ9862",
            "resultType": "Disclosure",
            "explanation": "Crossed upper threshold: 10.00",
            "value": 13.00,
            "portfolioId": "11"
            "disclosureThreshold": 10.00
            "directionCrossed": "Upwards"
        }
        ]
    }],
    "totalRulesChecked": [
        {
            "portfolioId": "11",
            "totalRulesChecked": 31
        }
    ],
    "unknownSummary": {}
}