Plaid.Accounts (plaid v3.0.0) View Source

Functions for Plaid accounts endpoint.

Link to this section Summary

Functions

Gets account data associated with Item.

Gets balance for specified accounts associated with Item.

Link to this section Types

Specs

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

Specs

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

Specs

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

Specs

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

Specs

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

Gets account data associated with Item.

Parameters

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

get_balance(params, config \\ %{})

View Source

Specs

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"]}}