Plaid.Auth (plaid v2.5.0) View Source

Functions for Plaid auth endpoint.

Link to this section Summary

Types

config()

params()

t()

Functions

get(params, config \\ %{})

Gets auth data associated with an Item.

Link to this section Types

config()

Specs

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

params()

Specs

params() :: %{
  :access_token => String.t(),
  optional(:options) => %{optional(:account_ids) => [String.t()]}
}

t()

Specs

t() :: %Plaid.Auth{
  accounts: [Plaid.Accounts.Account.t()],
  item: Plaid.Item.t(),
  numbers: %{
    ach: [Plaid.Auth.Numbers.ACH.t()],
    eft: [Plaid.Auth.Numbers.EFT.t()],
    international: [Plaid.Auth.Numbers.International.t()],
    bacs: [Plaid.Auth.Numbers.BACS.t()]
  },
  request_id: String.t()
}

Link to this section Functions

get(params, config \\ %{})

Specs

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

Gets auth data associated with an Item.

Parameters

%{
  access_token: "access-env-identifier",
  options: %{
    account_ids: [
    ]
  }
}