Plaid.Institutions (plaid v3.0.0) View Source

Functions for Plaid institutions endpoint.

Link to this section Summary

Functions

Gets all institutions. Results paginated.

Gets an institution by id.

Searches institutions by name and product.

Link to this section Types

Specs

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

Specs

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

Specs

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

Specs

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

Link to this section Functions

Link to this function

get(params, config \\ %{})

View Source

Specs

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

Gets all institutions. Results paginated.

Parameters

%{count: 50, offset: 0}
Link to this function

get_by_id(params, config \\ %{})

View Source

Specs

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}}
Link to this function

search(params, config \\ %{})

View Source

Specs

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

Searches institutions by name and product.

Parameters

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