View Source Plaid.Auth (elixir_plaid v1.2.1)

Plaid Auth API calls and schema.

Link to this section Summary

Functions

Get information about account and routing numbers for checking and savings accounts.

Link to this section Functions

Link to this function

get(access_token, options \\ %{}, config)

View Source

Specs

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

Get information about account and routing numbers for checking and savings accounts.

Does a POST /auth/get call which returns high level account information along with account and routing numbers for checking and savings accounts.

Params:

  • access_token - Token to fetch accounts for.

Options:

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

examples

Examples

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