PlaidEx.API.Accounts (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Accounts API — retrieve account and balance information.

Summary

Functions

get(config, access_token, opts \\ [])

Returns all accounts for an Item.

get_balance(config, access_token, opts \\ [])

Returns real-time balances for all accounts or specified account IDs.

Functions

get(config, access_token, opts \\ [])

@spec get(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, %{accounts: [PlaidEx.Schemas.Account.t()], item: map()}}
  | {:error, PlaidEx.Error.t()}

Returns all accounts for an Item.

get_balance(config, access_token, opts \\ [])

@spec get_balance(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, %{accounts: [PlaidEx.Schemas.Account.t()]}}
  | {:error, PlaidEx.Error.t()}

Returns real-time balances for all accounts or specified account IDs.