getTransactionsread-only

Get the wallet’s transaction list, containing past and pending transactions.

Request:

The request args must be a TransactionsRequest object.

Response:

On success, the result is a TransactionsResponse object.

Details:

Refresh transactions are excluded from the result unless includeRefreshes is set.

With the default sort orders (ascending and descending), pending transactions (major states pending, aborting and dialog) are listed before all other transactions; within each group, transactions are sorted by their timestamp, and ties are broken by a fixed transaction-type order. With stable-ascending, all transactions are sorted purely by ascending timestamp, so pending transactions do not jump around.

Filtering by an auditor scope (scopeInfo of type auditor) is not supported and fails with WALLET_CORE_API_BAD_REQUEST.

interface TransactionsRequest {
  // Return only transactions in the given currency.
  // Deprecated: use scopeInfo instead.
  currency?: string;

  // Return only transactions in the given scope.
  scopeInfo?: ScopeInfo;

  // Limit results to transactions related to the given search
  // string.  Currently accepted but not applied by wallet-core.
  search?: string;

  // Sort order of the transaction items.  "ascending" (the
  // default) and "descending" sort by timestamp but list pending
  // transactions first; "stable-ascending" sorts purely by
  // ascending timestamp, with pending transactions in between.
  sort?: "ascending" | "descending" | "stable-ascending";

  // If true, include all refreshes in the transaction list.
  includeRefreshes?: boolean;

  // If set, only return transactions matching the state filter.
  filterByState?: TransactionStateFilter;
}

// State filter for the transaction list: only transactions in a
// non-final state.
type TransactionStateFilter = "nonfinal";

interface TransactionsResponse {
  // List of past and pending transactions matching the request;
  // see the respective operation for the sort order.
  transactions: Transaction[];
}

type WithdrawalType =
  | "taler-bank-integration-api"
  | "manual-transfer";