View Source Plaid.Institutions (plaid v3.3.0)

Functions for Plaid institutions endpoint.

Link to this section Summary

config()

error()

params()

t()

Gets all institutions. Results paginated.

Gets an institution by id.

Searches institutions by name and product.

@type config() :: %{required(atom()) => String.t() | keyword()}

@type error() :: {:error, Plaid.Error.t() | any()} | no_return()

@type params() :: %{required(atom()) => term()}

@type t() :: %Plaid.Institutions{
  institutions: [Plaid.Institutions.Institution.t()],
  request_id: String.t(),
  total: integer()
}

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

Gets all institutions. Results paginated.

Parameters

%{count: 50, offset: 0}

@spec get_by_id(String.t() | params(), config()) ::
  {:ok, Plaid.Institutions.Institution.t()} | error()

Gets an institution by id.

Parameters

"ins_109512"

OR

%{institution_id: "ins_109512", options: %{include_optional_metadata: true, include_status: false}}

@spec search(params(), config()) :: {:ok, t()} | error()

Searches institutions by name and product.

Parameters

%{query: "Wells", products: ["transactions"], options: %{limit: 40, include_display_data: true}}