Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    AccountGroupKey AccountGroupKey Query-String The key of the account group to which the resource belongs.
    AccountKey AccountKey Query-String The keys of the accounts to which the resource belongs.
    AmountTypeId String Query-String Amount Type Id of the owed amount, for which you want instruments returned.
    ClientKey ClientKey Query-String The key of the client to which the resource belongs.
    Currency String Query-String Currency code of the owed amount, for which you want instruments returned.
  • Response Parameters

    View Response Codes
    Name Type Description
    AssetType AssetType The AssetType of the instrument
    CashFlows CashFlow [] Array containing value dated amounts in the owed currency for the instrument
    InstrumentDescription String Instrument Name e:g Amazon.com Inc.
    InstrumentSymbol String Instrument Symbol Code e:g AMZN:xnas
    Total Decimal Total amount owed for the instrument
    Uic Int Instrument Uic
  • Request Example

    Request URL
    GET hist/v1/unsettledamounts/instruments/?Currency=stringValue&AmountTypeId=stringValue&ClientKey=AbSTLYSoo499JZpp|ckGFw==&AccountGroupKey=QEPWm2RyUefWudKFjRaJag==&AccountKey=7wfA7-TCgQ0ygd||aOXY0w==
  • Response Example

    Response body
    {
      "Data": [
        {
          "AssetType": "FxSpot",
          "CashFlows": [
            {
              "Amount": 274.0,
              "ValueDate": "2022-10-03"
            }
          ],
          "InstrumentDescription": "Phillip Inc.",
          "InstrumentSymbol": "PI:xnys",
          "Total": 320.45,
          "Uic": 32154
        }
      ]
    }