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
Specs
error() :: {:error, Plaid.Error.t() | any()} | no_return()
Specs
Specs
t() :: %Plaid.Institutions{ institutions: [Plaid.Institutions.Institution.t()], request_id: String.t(), total: integer() }
Link to this section Functions
Specs
Gets all institutions. Results paginated.
Parameters
%{count: 50, offset: 0}
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}}
Specs
Searches institutions by name and product.
Parameters
%{query: "Wells", products: ["transactions"], options: %{limit: 40, include_display_data: true}}