Plaid.Institutions.get_by_id
You're seeing just the function
get_by_id
, go back to Plaid.Institutions module for more information.
Specs
get_by_id(String.t(), [String.t()], options, Plaid.config()) :: {:ok, Plaid.Institutions.GetByIdResponse.t()} | {:error, Plaid.Error.t()} when options: %{ optional(:products) => [String.t()], optional(:routing_numbers) => [String.t()], optional(:oauth) => boolean(), optional(:include_optional_metadata) => boolean() }
Get information about a Plaid institution.
Does a POST /institutions/get_by_id
call to retrieve a Plaid
institution by it's ID.
Params
institution_id
- The ID of the institution to get details about.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.:include_status
- When true, the response will include status information about the institution.
Examples
Institutions.get_by_id("ins_1", ["CA", "GB], client_id: "123", secret: "abc")
{:ok, %Institutions.GetByIdResponse{}}