Plaid.Institutions.search
You're seeing just the function
search
, go back to Plaid.Institutions module for more information.
Specs
search(params, options, Plaid.config()) :: {:ok, Plaid.Institutions.SearchResponse.t()} | {:error, Plaid.Error.t()} when params: %{ query: String.t(), products: [String.t()], country_codes: [String.t()] }, options: %{ optional(:include_optional_metadata) => boolean(), optional(:oauth) => boolean(), optional(:account_filter) => map() }
Get information about all Plaid institutions matching the search params.
Does a POST /institutions/search
call to list the supported Plaid
institutions with their details based on your search query.
Params
:query
- The search query. Institutions with names matching the query are returned:products
- Filter the Institutions based on whether they support listed products.:country_codes
- Array of country codes the institution supports.
Options
:include_optional_metadata
- When true, return the institution's homepage URL, logo and primary brand color.:oauth
- Filter institutions with or without OAuth login flows.:account_filter
- Object allowing account type -> sub-type filtering.
See Account Type Schema for more details on the
account_filter
option.
Examples
Institutions.search(%{query: "Ally", products: ["auth"], country_codes: ["US"]}, client_id: "123", secret: "abc")
{:ok, %Institutions.SearchResponse{}}