Skip to main content
GET
/
transactions
/
cash-activity
Get cash activity
curl --request GET \
  --url https://{host}/transactions/cash-activity \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
[
  {
    "id": "507f1f77bcf86cd799439013",
    "activityGroup": "cash",
    "activityType": "Deposit",
    "displayDate": "2025-01-15T14:20:00Z",
    "status": "Settled",
    "currency": "EUR",
    "amount": 5000,
    "cashFlowSign": 1,
    "owner": "507f1f77bcf86cd799439011"
  },
  {
    "id": "507f1f77bcf86cd799439014",
    "activityGroup": "cash",
    "activityType": "Withdraw",
    "displayDate": "2025-01-12T11:15:00Z",
    "status": "Settled",
    "currency": "EUR",
    "amount": 1000,
    "cashFlowSign": -1,
    "owner": "507f1f77bcf86cd799439011"
  },
  {
    "id": "507f1f77bcf86cd799439017",
    "activityGroup": "cash",
    "activityType": "Investments",
    "displayDate": "2025-01-10T09:00:00Z",
    "status": "Settled",
    "currency": "EUR",
    "amount": 2000,
    "cashFlowSign": -1,
    "owner": "507f1f77bcf86cd799439011",
    "details": {
      "orders": [
        {
          "id": "507f1f77bcf86cd799439017",
          "side": "Buy",
          "status": "Settled",
          "isin": "US0378331005",
          "quantity": 4,
          "consideration": {
            "currency": "EUR",
            "amount": 2000
          },
          "unitPrice": {
            "amount": 500,
            "currency": "USD"
          },
          "executionWindow": {
            "type": "market-hours",
            "executionType": "MARKET_HOURS"
          },
          "settledAt": "2025-01-15T00:00:00.000Z",
          "createdAt": "2025-01-15T10:30:00Z",
          "displayDate": "2025-01-15T10:30:00Z",
          "isCancellable": false,
          "fxRate": {
            "rate": 1.15,
            "currency": "USD"
          }
        }
      ]
    }
  },
  {
    "id": "507f1f77bcf86cd799439018",
    "activityGroup": "cash",
    "activityType": "Dividends",
    "displayDate": "2025-01-08T08:00:00Z",
    "status": "Settled",
    "currency": "EUR",
    "amount": 25.5,
    "cashFlowSign": 1,
    "owner": "507f1f77bcf86cd799439011",
    "details": {
      "isin": "US0378331005",
      "asset": "equities_apple"
    }
  }
]
Returns the user’s cash activity sorted by display date in descending order (newest first). This includes:
  • Deposit transactions – incoming cash deposits and savings withdrawals
  • Withdraw transactions – cash withdrawals and savings top-ups
  • Investments – all asset transactions (excluding those linked to gifts)
  • Dividends – stock dividend payments

​
Query parameters

​
limit
integer
default:"unlimited"
Optional limit on the number of results to return. Must be a non-negative integer. If omitted, returns all available results.

​
Response

Each transaction activity item includes:
  • activityGroup – Always "cash" for this endpoint
  • activityType – One of: Deposit, Withdraw, Investments, Dividends
  • displayDate – ISO 8601 date-time when the transaction occurred or was displayed
  • status – Current transaction status (e.g., Settled, Pending)
  • currency – ISO 4217 currency code
  • amount – Transaction amount in major units (e.g., 5000.00 for €5,000.00)
  • consideration – Transaction consideration with currency and amount (optional)
  • cashFlowSign – 1 for positive cash flow (deposits, dividends), -1 for negative cash flow (withdrawals, investments)
  • owner – The unique identifier of the user who owns this transaction
  • details – Optional additional information, including order summaries for transactions with orders, or asset info for dividend transactions

​
Order summaries

When a transaction includes orders (e.g., investment transactions), the details.orders array contains order summaries with:
  • id – Order identifier
  • isin – International Securities Identification Number
  • side – Order side (Buy or Sell)
  • quantity – Number of shares/units (optional)
  • consideration – Order consideration amount and currency (optional)
  • unitPrice – Price per unit (per share) with amount and currency (optional, present when available)
  • fxRate – Exchange rate used for currency conversion with rate and currency (optional, present for foreign currency orders)

​
Dividend details

When a transaction is a dividend (activityType: "Dividends"), the details object contains:
  • isin – International Securities Identification Number of the asset that paid the dividend
  • asset – Asset ID (e.g., equities_apple for Apple)

Authorizations

​
Authorization
string
header
required

OAuth 2.0 bearer token issued by Wealthyhood. Include this token in the Authorization header as Bearer <token>.

Headers

​
x-user-id
string
required

The unique identifier for the acting customer. Must match the user associated with the bearer token.

Example:

"bank-user-12345"

Query Parameters

​
limit
integer

Optional limit on the number of results to return. If omitted, returns all available results.

Required range: x >= 1
Example:

50

Response

Cash activity response.

​
id
string
required

The unique identifier of the transaction.

Example:

"507f1f77bcf86cd799439011"

​
activityGroup
enum<string>
required

The activity group this transaction belongs to.

Available options:
investment,
cash,
savings
Example:

"investment"

​
activityType
string
required

The specific activity type. Values depend on activityGroup:

  • investment: Buy, Sell, Rebalance, Dividends
  • cash: Deposit, Withdraw, Investments, Dividends
  • savings: cashToSavings, savingsToCash, savingsInterest
Example:

"Buy"

​
displayDate
string<date-time>
required

The date/time when this transaction occurred or was displayed. For settled transactions, this is typically the settlement date.

Example:

"2025-01-15T10:30:00Z"

​
status
enum<string>
required

The current status of the transaction. Valid statuses depend on the activityGroup:

  • investment: Pending, Cancelled, Settled, Rejected
  • cash: Pending, Settled
  • savings: Pending, Settled
Available options:
Pending,
Cancelled,
Rejected,
Settled
Example:

"Settled"

​
currency
enum<string>
required

ISO 4217 currency code.

Available options:
GBP,
EUR,
USD
Example:

"EUR"

​
amount
number
required

Transaction amount in major units (e.g., 12.34 for €12.34).

Required range: x >= 0
Example:

1000

​
owner
string
required

The unique identifier of the user who owns this transaction.

Example:

"507f1f77bcf86cd799439011"

​
consideration
object

Transaction consideration with currency and amount

​
cashFlowSign
enum<integer>

Indicates whether this transaction represents a positive (1) or negative (-1) cash flow. This field is only present for cash activity transactions (activityGroup: "cash"). Positive cash flows include deposits, dividends, and withdrawals from savings. Negative cash flows include withdrawals, investments, and savings top-ups.

Available options:
1,
-1
Example:

-1

​
details
object

Optional additional details specific to the transaction type.

  • For investment transactions (Buy, Sell, Rebalance): InvestmentDetails with orders array
  • For dividend transactions (Dividends): DividendDetails with isin and asset
  • For savings transactions (cashToSavings, savingsToCash, savingsInterest): SavingsDetails with savingsProductId and optional orders array
  • For cash transactions with activityType "Investments": InvestmentDetails with orders array
  • For cash transactions with activityType "Dividends": DividendDetails with isin and asset