Plaid.Accounts (plaid v2.5.0) View Source

Functions for Plaid accounts endpoint.

Link to this section Summary

config()

params()

t()

Gets account data associated with Item.

Gets balance for specified accounts associated with Item.

config() :: %{required(atom()) => String.t()}

params() :: %{required(atom()) => String.t() | [String.t()] | map()}

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

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

Gets account data associated with Item.

Parameters

%{access_token: "access-token"}

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

Gets balance for specified accounts associated with Item.

Parameters

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