plaid v1.1.0 Plaid.Accounts

Functions for Plaid accounts endpoint.

Link to this section Summary

Functions

Gets account data associated with Item

Gets real-time balance for specifed accounts associated with Item

Link to this section Types

Link to this type t()
t() :: %Plaid.Accounts{
  accounts: [Plaid.Accounts.Account.t()],
  item: Plaid.Item.t(),
  request_id: String.t()
}

Link to this section Functions

Link to this function get(params, cred \\ get_cred())
get(map(), map() | nil) ::
  {:ok, Plaid.Accounts.t()} | {:error, Plaid.Error.t()}

Gets account data associated with Item.

params = %{access_token: "access-token"}

Link to this function get_balance(params, cred \\ get_cred())
get_balance(map(), map() | nil) ::
  {:ok, Plaid.Accounts.t()} | {:error, Plaid.Error.t()}

Gets real-time balance for specifed accounts associated with Item.

params = %{access_token: "access-token", options: %{account_ids: ["account-id"]}}