Specs

get(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Accounts.GetResponse.t()} | {:error, Plaid.Error.t()}
when options: %{optional(:account_ids) => [String.t()]}

Get information about all available accounts.

Does a POST /accounts/get call to retrieve high level account information associated with an access_token's item.

Params:

• access_token - Token to fetch accounts for.

Options:

• :account_ids - Specific account ids to fetch accounts for.

examples

Examples

Accounts.get("access-sandbox-123xxx", client_id: "123", secret: "abc")
{:ok, %Accounts.GetResponse{}}

Specs

get_balance(String.t(), options, Plaid.config()) ::
  {:ok, Plaid.Accounts.GetResponse.t()} | {:error, Plaid.Error.t()}
when options: %{optional(:account_ids) => [String.t()]}

Get information about all available balances.

Does a POST /accounts/balance/get call to retrieve real-time balance information for all accounts associated with an access_token's item.

This API call will force balances to be refreshed, rather than use the cache like other API calls that return balances.

Params:

• access_token - Token to fetch accounts for.

Options:

• :account_ids - Specific account ids to fetch balances for.

examples

Examples

Accounts.get_balance("access-sandbox-123xxx", client_id: "123", secret: "abc")
{:ok, %Accounts.GetResponse{}}