plaid v1.1.2 Plaid.Auth View Source

Functions for Plaid auth endpoint.

Link to this section Summary

Functions

Gets auth data associated with an Item

Link to this section Types

Link to this type cred() View Source
cred() :: %{required(atom()) => String.t()}
Link to this type params() View Source
params() :: %{
  :access_token => String.t(),
  optional(:options) => %{optional(:account_ids) => [String.t()]}
}
Link to this type t() View Source
t() :: %Plaid.Auth{
  accounts: [Plaid.Accounts.Account.t()],
  item: Plaid.Item.t(),
  numbers: [Plaid.Auth.Number.ACH.t()],
  request_id: String.t()
}

Link to this section Functions

Link to this function get(params, cred \\ get_cred()) View Source
get(params(), cred() | nil) :: {:ok, Plaid.Auth.t()} | {:error, Plaid.Error.t()}

Gets auth data associated with an Item.

Parameters

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