Plaid.Institutions.get
You're seeing just the function
get
, go back to Plaid.Institutions module for more information.
Specs
get(params, options, Plaid.config()) :: {:ok, Plaid.Institutions.GetResponse.t()} | {:error, Plaid.Error.t()} when params: %{count: integer(), offset: integer(), country_codes: [String.t()]}, options: %{ optional(:products) => [String.t()], optional(:routing_numbers) => [String.t()], optional(:oauth) => boolean(), optional(:include_optional_metadata) => boolean() }
Get information about Plaid institutions.
Does a POST /institutions/get
call to list the supported Plaid
institutions with their details.
Params
:count
- The total number of Institutions to return.:offset
- The number of Institutions to skip.:country_codes
- Array of country codes the institution supports.
Options
:products
- Filter based on which products they support.:routing_numbers
- Filter based on routing numbers.:oauth
- Filter institutions with or without OAuth login flows.:include_optional_metadata
- When true, return the institution's homepage URL, logo and primary brand color.
Examples
Institutions.get(%{count: 25, offset: 0, country_codes: ["CA", "GB]}, client_id: "123", secret: "abc")
{:ok, %Institutions.GetResponse{}}