View Source Plaid.Accounts (plaid v3.3.0)

Functions for Plaid accounts endpoint.

Link to this section Summary

config()

error()

params()

t()

Gets account data associated with Item.

Gets balance for specified accounts associated with Item.

@type config() :: %{required(atom()) => String.t() | keyword()}

@type error() :: {:error, Plaid.Error.t() | any()} | no_return()

@type params() :: %{required(atom()) => term()}

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

@spec get(params(), config()) :: {:ok, t()} | error()

Gets account data associated with Item.

Parameters

%{access_token: "access-token"}

@spec get_balance(params(), config()) :: {:ok, t()} | error()

Gets balance for specified accounts associated with Item.

Parameters

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