Plaid.Link (plaid v2.5.0) View Source

Functions for Plaid link endpoint.

Link to this section Summary

Types

config()

params()

t()

Functions

create_link_token(params, config \\ %{})

Creates a Link Token.

get_link_token(params, config \\ %{})

Gets a Link Token's information.

Link to this section Types

config()

Specs

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

params()

Specs

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

t()

Specs

t() :: %Plaid.Link{
  created_at: String.t(),
  expiration: String.t(),
  link_token: String.t(),
  metadata: Plaid.Link.Metadata.t(),
  request_id: String.t()
}

Link to this section Functions

create_link_token(params, config \\ %{})

Specs

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

Creates a Link Token.

Parameters

%{
  client_name: "",
  language: "",
  country_codes: "",
  user: %{client_user_id: ""}
}

get_link_token(params, config \\ %{})

Specs

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

Gets a Link Token's information.

Parameters

%{
  link_token: ""
}