Skip to main content
GET
/
transactions
/
pending-cashflow-activity
Get pending cash flows
curl --request GET \
  --url https://{host}/transactions/pending-cashflow-activity \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
[
  {
    "id": "507f1f77bcf86cd799439020",
    "owner": "507f1f77bcf86cd799439011",
    "activityGroup": "pendingCashflows",
    "activityType": "Deposit",
    "status": "Pending",
    "displayDate": "2025-01-15T14:20:00Z",
    "consideration": {
      "currency": "EUR",
      "amount": 500
    },
    "cashFlowSign": 1
  },
  {
    "id": "507f1f77bcf86cd799439021",
    "owner": "507f1f77bcf86cd799439011",
    "activityGroup": "pendingCashflows",
    "activityType": "SavingsWithdrawal",
    "status": "Pending",
    "displayDate": "2025-01-14T10:00:00Z",
    "consideration": {
      "currency": "EUR",
      "amount": 200
    },
    "cashFlowSign": 1,
    "details": {
      "savingsProductId": "mmf_dist_eur",
      "orders": []
    }
  }
]

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"

Response

Pending cash flows 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,
pendingCashflows
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
  • pendingCashflows: Deposit, SavingsWithdrawal
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 (user-visible settlement; e.g. deposits may show Settled once funds are received while internal settlement is still pending)
  • savings: Pending, Settled
  • pendingCashflows: Pending
Available options:
Pending,
Cancelled,
Rejected,
Settled
Example:

"Settled"

​
owner
string
required

The unique identifier of the user who owns this transaction.

Example:

"507f1f77bcf86cd799439011"

​
currency
enum<string>

ISO 4217 currency code. Required for investment, cash, and savings activity. Omitted for pendingCashflows (use consideration instead).

Available options:
GBP,
EUR,
USD
Example:

"EUR"

​
amount
number

Transaction amount in major units (e.g., 12.34 for €12.34). Required for investment, cash, and savings activity. Omitted for pendingCashflows (use consideration instead).

Required range: x >= 0
Example:

1000

​
consideration
object

Optional transaction consideration with currency and amount. Used by pendingCashflows activity instead of top-level currency and amount.

​
cashFlowSign
enum<integer>

Indicates whether this transaction represents a positive (1) or negative (-1) cash flow. Present for cash activity (activityGroup: "cash") and pending cashflow activity (activityGroup: "pendingCashflows"). 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
  • For pendingCashflows with activityType "SavingsWithdrawal": SavingsDetails with savingsProductId and empty orders array