Lithic.Resources.FinancialAccounts (Lithic v1.0.0)

Copy Markdown View Source

Financial accounts — ledger, balances, financial transactions, account numbers, and credit config.

Summary

Functions

create(params, opts \\ [])

@spec create(
  map(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

get(financial_account_token, opts \\ [])

@spec get(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

get_account_activity_transaction(financial_account_token, activity_token, opts \\ [])

@spec get_account_activity_transaction(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

get_credit_config(financial_account_token, opts \\ [])

@spec get_credit_config(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, Lithic.Error.t()}

Get credit configuration for a financial account.

get_financial_transaction(financial_account_token, financial_transaction_token, opts \\ [])

@spec get_financial_transaction(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

list(opts \\ [])

@spec list(keyword()) :: {:ok, Lithic.Page.t(map())} | {:error, Lithic.Error.t()}

list_account_activity(financial_account_token, opts \\ [])

@spec list_account_activity(
  String.t(),
  keyword()
) :: {:ok, Lithic.Page.t(map())} | {:error, Lithic.Error.t()}

list_financial_transactions(financial_account_token, opts \\ [])

@spec list_financial_transactions(
  String.t(),
  keyword()
) :: {:ok, Lithic.Page.t(map())} | {:error, Lithic.Error.t()}

register_account_number(financial_account_token, params, opts \\ [])

@spec register_account_number(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

Register an account number for a financial account.

stream(opts \\ [])

@spec stream(keyword()) :: Enumerable.t()

update(financial_account_token, params, opts \\ [])

@spec update(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

update_credit_config(financial_account_token, params, opts \\ [])

@spec update_credit_config(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}

Update credit configuration for a financial account.

update_status(financial_account_token, params, opts \\ [])

@spec update_status(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Lithic.Error.t()}