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.
  • Response Parameters

    View Response Codes
    Name Type Description
    CashFlows CashFlow []
    Currency String The requester's primary currency
    Exchanges ExchangeBreakdown [] Array containing value dated amounts by exchange, for owed currency
    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/?ClientKey=AbSTLYSoo499JZpp|ckGFw==&AmountTypeSource=TransactionsNotBooked&AccountGroupKey=QEPWm2RyUefWudKFjRaJag==&AccountKey=7wfA7-TCgQ0ygd||aOXY0w==
  • Response Example

    Response body
    {
      "CashFlows": [
        {
          "Amount": -0.57,
          "ValueDate": "2022-10-06"
        },
        {
          "Amount": -15.40352205,
          "ValueDate": "2022-10-16"
        }
      ],
      "Currency": "DKK",
      "Exchanges": [
        {
          "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
        },
        {
          "CashFlows": [
            {
              "Amount": -15.40352205,
              "ValueDate": "2022-10-16"
            }
          ],
          "Currencies": [
            {
              "CashFlows": [
                {
                  "Amount": -15.40352205,
                  "ValueDate": "2022-10-16"
                }
              ],
              "Currency": "EUR",
              "Total": -2.07
            }
          ],
          "Currency": "EUR",
          "ExchangeId": "NoExchange",
          "Total": -15.40352205
        }
      ],
      "Total": -15.97352205
    }