plaid v1.1.0 Plaid.Item

Functions for Plaid Item endpoint.

Link to this section Summary

Functions

Creates a processor token used to create an authenticated funding source with Dwolla

Creates a public token. To be used to put Plaid Link into update mode

Exchanges a public token for an access token and item_id

Invalidates access token and returns a new one

Updates an Item’s webhook

Link to this section Types

Link to this type t()
t() :: %Plaid.Item{
  available_products: [String.t()],
  billed_products: [String.t()],
  error: String.t(),
  institution_id: String.t(),
  item_id: String.t(),
  request_id: String.t(),
  webhook: String.t()
}

Link to this section Functions

Link to this function create_processor_token(params, cred \\ get_cred())
create_processor_token(map(), map() | nil) ::
  {:ok, map()} | {:error, Plaid.Error.t()}

Creates a processor token used to create an authenticated funding source with Dwolla.

params = %{access_token: "access-env-identifier", account_id: "plaid-account-id"}

Link to this function create_public_token(params, cred \\ get_cred())
create_public_token(map(), map() | nil) ::
  {:ok, map()} | {:error, Plaid.Error.t()}

Creates a public token. To be used to put Plaid Link into update mode.

params = %{access_token: "access-env-identifier"}

Link to this function delete(params, cred \\ get_cred())
delete(map(), map() | nil) :: {:ok, map()} | {:error, Plaid.Error.t()}

Deletes an Item.

params = %{access_token: "access-env-identifier"}

Link to this function exchange_public_token(params, cred \\ get_cred())
exchange_public_token(map(), map() | nil) ::
  {:ok, map()} | {:error, Plaid.Error.t()}

Exchanges a public token for an access token and item_id.

params = %{public_token: "public-env-identifier"}

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

Gets an Item.

params = %{access_token: "access-env-identifier"}

Link to this function rotate_access_token(params, cred \\ get_cred())
rotate_access_token(map(), map() | nil) ::
  {:ok, map()} | {:error, Plaid.Error.t()}

Invalidates access token and returns a new one.

params = %{access_token: "access-env-identifier"}

Link to this function update_version_access_token(params, cred \\ get_cred())
update_version_access_token(map(), map() | nil) ::
  {:ok, map()} | {:error, Plaid.Error.t()}

Updates a V1 access token to V2.

params = %{access_token_v1: "test_wells"}

Link to this function update_webhook(params, cred \\ get_cred())
update_webhook(map(), map() | nil) ::
  {:ok, Plaid.Item.t()} | {:error, Plaid.Error.t()}

Updates an Item’s webhook.

params = %{access_webhook: "access-env-identifier", webhook: "http://mywebsite/api"}