MoneyHub.RegularTransactions (MoneyHub v1.0.0)

Copy Markdown View Source

Regular transaction series detection: recurring payments (subscriptions, rent, salary) automatically identified from transaction history.

See Regular Transaction Series and Regular Transaction Webhooks.

Summary

Functions

Fetches a single detected series by id.

Lists detected regular transaction series for the user identified by token.

Types

series()

@type series() :: map()

Functions

get(config, token, series_id)

@spec get(MoneyHub.Config.t(), String.t(), String.t()) ::
  {:ok, series()} | {:error, MoneyHub.Error.t()}

Fetches a single detected series by id.

list(config, token, opts \\ [])

@spec list(MoneyHub.Config.t(), String.t(), keyword()) ::
  {:ok, [series()]} | {:error, MoneyHub.Error.t()}

Lists detected regular transaction series for the user identified by token.

Options

  • :account_id - filter to a single account.