plaid v1.8.0 Plaid.Institutions 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
Link to this type
t()
View Sourcet() :: %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 Sourceget(params(), config() | nil) :: {:ok, Plaid.Institutions.t()} | {:error, Plaid.Error.t()}
Gets all institutions. Results paginated.
Parameters
%{count: 50, offset: 0}
Link to this function
get_by_id(id, config \\ %{})
View Sourceget_by_id(String.t(), config() | nil) :: {:ok, Plaid.Institutions.Institution.t()} | {:error, Plaid.Error.t()}
Gets an institution by id.
Link to this function
search(params, config \\ %{})
View Sourcesearch(params(), config() | nil) :: {:ok, Plaid.Institutions.t()} | {:error, Plaid.Error.t()}
Searches institutions by name and product.
Parameters
%{query: "Wells", products: ["transactions"], options: %{limit: 40, include_display_data: true}}