plaid v1.7.3 Plaid.Accounts View Source

Functions for Plaid accounts endpoint.

Link to this section Summary

Functions

Gets account data associated with Item.

Gets balance for specifed accounts associated with Item.

Link to this section Types

Link to this type

config()

View Source
config() :: %{required(atom()) => String.t()}
Link to this type

params()

View Source
params() :: %{required(atom()) => String.t() | map()}
Link to this type

t()

View Source
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, config \\ %{})

View Source
get(params(), config() | nil) ::
  {:ok, Plaid.Accounts.t()} | {:error, Plaid.Error.t()}

Gets account data associated with Item.

Parameters

%{access_token: "access-token"}
Link to this function

get_balance(params, config \\ %{})

View Source
get_balance(params(), config() | nil) ::
  {:ok, Plaid.Accounts.t()} | {:error, Plaid.Error.t()}

Gets balance for specifed accounts associated with Item.

Parameters

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