Skip to content
Documentation
/
/
/
Accessing Transactions Re...

Accessing transactions reports

You can call up historical transaction data via the Upvest API or subscribe to transaction events to receive them automatically.

Prerequisites

  • Authentication scopes — reports:read, transactions:read

    For more information, refer to Authentication scopes.

Before retrieving transaction reports, ensure you have:

  • Webhook handler ready — Set up a webhook endpoint to listen for report generation events.

Requirements

Since these are reports of transactions between account and account groups, the account and account group must have already been created.

1. List cash transactions

To retrieve a list of cash transactions via the API, proceed as follows:

GET /transactions/cash

Example response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "type": "ORDER_EXECUTION",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "delta": {
        "amount": "-305.00",
        "currency": "EUR"
      },
      "taxes": [
        {
          "amount": "5.00",
          "currency": "EUR",
          "type": "TOTAL"
        }
      ],
      "taxes_details": {
        "total_amount": {
          "amount": "5.00",
          "currency": "EUR"
        },
        "tax_breakdown": [
          {
            "amount": "5.00",
            "currency": "EUR",
            "type": "FINANCIAL_TRANSACTION_TAX",
            "taxing_jurisdiction": "FR"
          }
        ]
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    },
    {
      "id": "9e7a3188-eff8-11ed-a05b-0242ac120003",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "type": "SEPA_DIRECT_DEBIT",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "delta": {
        "amount": "100.00",
        "currency": "EUR"
      },
      "taxes": [],
      "taxes_details": {
        "total_amount": {
          "amount": "0.00",
          "currency": "EUR"
        },
        "tax_breakdown": []
      },
      "references": [
        {
          "id": "98f01200-eff8-11ed-a05b-0242ac120003",
          "type": "DIRECT_DEBIT"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    }
  ]
}

2. List securities transactions

To retrieve a list of securities transactions via the Investment API, submit the following call:

GET /transactions/securities

Example response

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 2,
    "total_count": 2,
    "sort": "booking_date",
    "order": "ASC"
  },
  "data": [
    {
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "type": "ORDER_EXECUTION",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "instrument": {
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
        "isin": "US0378331005"
      },
      "delta": {
        "amount": "-2.5234543879"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    },
    {
      "id": "6dc9fbca-8835-11ed-a217-2eabd0c03f8a",
      "created_at": "2023-01-01T00:00:00.000Z",
      "updated_at": "2023-01-01T00:00:00.000Z",
      "type": "ORDER_EXECUTION_CANCELLATION",
      "account_id": "db6290bb-1491-45bf-aafe-262dad59d497",
      "account_group_id": "6409e3f2-8835-11ed-96a4-2eabd0c03f8a",
      "instrument": {
        "uuid": "ccb86937-8a39-4160-8d33-85bf9e902321",
        "isin": "US0378331005"
      },
      "delta": {
        "amount": "2.5234543879"
      },
      "references": [
        {
          "id": "7579a672-8835-11ed-9455-2eabd0c03f8a",
          "type": "ORDER_EXECUTION"
        },
        {
          "id": "1f5758d3-1ef7-4b4c-96ec-6b3da2bf1a8a",
          "type": "ORDER"
        }
      ],
      "booking_date": "2023-01-01T00:00:00.000Z",
      "value_date": "2023-01-01T00:00:00.000Z"
    }
  ]
}

3. Retrieving additional transactions information

With every response via the /transactions endpoint, a references object is supplied, which you can use to obtain additional transaction information from other endpoints.

Example

In the following example, the references object for a cash transaction was returned, which contains an ID and the transaction type DIRECT_DEBIT.

"references": [
  {
    "id": "98f01200-eff8-11ed-a05b-0242ac120003",
    "type": "DIRECT_DEBIT"
  }
]

Call the /direct-debit endpoint using the ID to fetch more details related to that cash transaction:

GET payments/direct_debits/{direct_debit_id}

Example response

{
    "meta": {
        "offset": 0,
        "limit": 100,
        "count": 1,
        "total_count": 1,
        "sort": "id",
        "order": "ASC"
    },
    "data": [
        {
            "id": "1ab4fef9-a097-4c6f-9345-647025d5fde6",
            "created_at": "2020-08-24T14:15:22Z",
            "user_id": "82b49999-1145-4e05-916a-567662daa7bc",
            "account_group_id": "1ea60f56-b67b-61fc-829a-0242ac130003",
            "mandate_id": "730b8719-0bc6-401d-98dd-b2de72afbf05",
            "cash_amount": "200.00",
            "currency": "EUR",
            "remittance_information": "payment for green energy portfolio",
            "status": "NEW",
            "purpose_code": "OTHR"
        }
    ]
}