MoneyHub.Accounts (MoneyHub v1.0.0)

Copy Markdown View Source

Account data: list, fetch, update, and delete accounts; manual account creation; account balances.

Accounts represent a single product at a financial institution (current account, savings, card, loan, mortgage, investment, pension, or property) connected via open banking, screen-scraping, or entered manually. See Accounts and Bank Connection Response for the full field reference.

Reading account identifiers (sort code, account number, IBAN, PAN) requires the accounts_details:read scope in addition to accounts:read - see Sensitive Information.

Summary

Types

account()

Functions

add_balance(config, token, account_id, attrs)

Adds a new balance entry for a manual account (one created via create/3). Not applicable to accounts backed by a live bank connection, whose balances are populated automatically by sync.

balances(config, token, account_id, opts \\ [])

Lists historical balance snapshots for an account.

create(config, token, attrs)

Creates a manual account (one not backed by a live bank connection) - for example a properties:residential valuation entry or an off-platform cash account. attrs is the account payload.

delete(config, token, account_id)

Deletes an account.

get(config, token, account_id)

Fetches a single account by id.

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

Lists accounts for the user identified by token.

standing_orders(config, token, account_id)

Lists the standing orders the bank itself reports for an account (AIS read), as distinct from standing orders created via MoneyHub.StandingOrders (PIS write). Requires accounts:read plus either standing_orders:read or standing_orders_detail:read.

syncs(config, token)

Retrieves sync status/metadata for every account belonging to the user identified by token.

update(config, token, account_id, attrs)

Updates a manual account's attributes.

Types

account()

@type account() :: map()

Functions

add_balance(config, token, account_id, attrs)

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

Adds a new balance entry for a manual account (one created via create/3). Not applicable to accounts backed by a live bank connection, whose balances are populated automatically by sync.

balances(config, token, account_id, opts \\ [])

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

Lists historical balance snapshots for an account.

See Historical Balances.

create(config, token, attrs)

@spec create(MoneyHub.Config.t(), String.t(), map()) ::
  {:ok, account()} | {:error, MoneyHub.Error.t()}

Creates a manual account (one not backed by a live bank connection) - for example a properties:residential valuation entry or an off-platform cash account. attrs is the account payload.

delete(config, token, account_id)

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

Deletes an account.

get(config, token, account_id)

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

Fetches a single account by id.

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

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

Lists accounts for the user identified by token.

Options

  • :connection_id - filter to accounts from a single connection.
  • :account_type - filter by account type ("cash", "savings", "card", "investment", "loan", "mortgage", "pension", "properties").

standing_orders(config, token, account_id)

@spec standing_orders(MoneyHub.Config.t(), String.t(), String.t()) ::
  {:ok, [map()]} | {:error, MoneyHub.Error.t()}

Lists the standing orders the bank itself reports for an account (AIS read), as distinct from standing orders created via MoneyHub.StandingOrders (PIS write). Requires accounts:read plus either standing_orders:read or standing_orders_detail:read.

syncs(config, token)

@spec syncs(MoneyHub.Config.t(), String.t()) ::
  {:ok, [map()]} | {:error, MoneyHub.Error.t()}

Retrieves sync status/metadata for every account belonging to the user identified by token.

update(config, token, account_id, attrs)

@spec update(MoneyHub.Config.t(), String.t(), String.t(), map()) ::
  {:ok, account()} | {:error, MoneyHub.Error.t()}

Updates a manual account's attributes.