plaid v1.1.0 Plaid.Institutions

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

Link to this type t()
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, cred \\ get_cred())
get(map(), map() | nil) ::
  {:ok, Plaid.Institutions.t()} | {:error, Plaid.Error.t()}

Gets all institutions. Results paginated.

params = %{count: 50, offset: 0}

Link to this function get_by_id(id, key \\ get_key())
get_by_id(String.t(), map() | nil) ::
  {:ok, Plaid.Institutions.Institution.t()} | {:error, Plaid.Error.t()}

Gets an institution by id.

Link to this function search(params, key \\ get_key())
search(map(), map() | nil) ::
  {:ok, Plaid.Institutions.t()} | {:error, Plaid.Error.t()}

Searches institutions by name and product.

params = %{query: "Wells", products: ["transactions"]}