Monzo.Accounts (monzo_client v1.0.0)

Copy Markdown View Source

The Accounts resource: listing the user's Monzo current accounts.

Summary

Types

list_params()

Functions

list(client, params \\ %{})

Returns a list of accounts owned by the currently authorised user.

Types

list_params()

@type list_params() :: %{optional(:type) => :uk_retail | :uk_retail_joint}

Functions

list(client, params \\ %{})

@spec list(Monzo.Client.t(), list_params()) ::
  {:ok, [Monzo.Account.t()]} | {:error, Exception.t()}

Returns a list of accounts owned by the currently authorised user.

{:ok, accounts} = Monzo.Accounts.list(client)
{:ok, joint_accounts} = Monzo.Accounts.list(client, %{type: :uk_retail_joint})