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.
    AmountTypeSource AmountTypeSource Query-String Specifies the response data granularity, providing access to source of AmountType.
    ClientKey ClientKey Query-String The key of the client to which the resource belongs.
    ExchangeId String Route The exchange identifier for which value dated amounts is requested. If no exchange is associated to those amounts, use "NoExchange" as the value.
  • Response Parameters

    View Response Codes
    Name Type Description
    CashFlows CashFlow []
    Currencies CurrencyBreakdown [] For each currency with an amounts owed, the value dated cash flows and associated details.
    Currency String The requester's primary currency
    ExchangeId String Exchange Identifier for the associated amounts. Additional information on the exchange can be looked up in the Reference Data service group. If a returned amount does not have an Exchange associated, no ExchangeId will be provided.
    Total Decimal Estimated total owed amount (converted to the requester's primary currency). Note: Amounts must be paid in the owed currency.
  • Request Example

    Request URL
    GET hist/v1/unsettledamounts/exchanges/NYSE/?ClientKey=AbSTLYSoo499JZpp|ckGFw==&AmountTypeSource=Financing&AccountGroupKey=QEPWm2RyUefWudKFjRaJag==&AccountKey=7wfA7-TCgQ0ygd||aOXY0w==
  • Response Example

    Response body
    {
      "CashFlows": [
        {
          "Amount": -0.57,
          "ValueDate": "2022-10-06"
        }
      ],
      "Currencies": [
        {
          "CashFlows": [
            {
              "Amount": -0.57,
              "ValueDate": "2022-10-06"
            }
          ],
          "Currency": "DKK",
          "Total": -0.57
        }
      ],
      "Currency": "DKK",
      "ExchangeId": "NYSE",
      "Total": -0.57
    }