Plaid.Institutions (plaid v2.5.0) View Source

Functions for Plaid institutions endpoint.

Link to this section Summary

config()

params()

t()

Gets all institutions. Results paginated.

Gets an institution by id.

Searches institutions by name and product.

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

params() :: %{required(atom()) => integer() | String.t() | list() | map()}

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

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

Gets all institutions. Results paginated.

Parameters

%{count: 50, offset: 0}

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

Gets an institution by id.

Parameters

"ins_109512"

OR

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

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

Searches institutions by name and product.

Parameters

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