plaid
plaid v3.3.0

View Source Plaid.Auth (plaid v3.3.0)

Functions for Plaid auth endpoint.

Link to this section Summary

Types

config()
error()
params()
t()

Functions

get(params, config \\ %{})

Gets auth data associated with an Item.

Link to this section Types

Link to this type

config()

View Source 
@type config() :: %{required(atom()) => String.t() | keyword()}
Link to this type

error()

View Source 
@type error() :: {:error, Plaid.Error.t() | any()} | no_return()
Link to this type

params()

View Source 
@type params() :: %{required(atom()) => term()}
Link to this type

t()

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

Link to this section Functions

Link to this function

get(params, config \\ %{})

View Source 
@spec get(params(), config()) :: {:ok, t()} | error()

Gets auth data associated with an Item.

Parameters

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