plaid v0.2.0 Plaid.Institutions
Functions for working with Plaid Institutions.
- Return all institutions
- Fetch an institution by id
- Return all long-tail institutions
- Search long-tail institutions
Plaid API Reference: https://plaid.com/docs/api/#institutions
Summary
Functions
Returns all Plaid Institutions
Fetchs an institution based on the id
Returns long-tail institutions
Returns long-tail institutions with user-supplied credentials
Returns a long-tail institution based on the id
Returns long-tail institutions based on query parameters
Functions
Specs
all :: {atom, list | map}
Returns all Plaid Institutions.
Returns the universe of institutions supported directly by Plaid. This endpoint requires no authentication.
Returns a list of Plaid.Institutions
or Plaid.Error
struct.
Example
{:ok, [%Plaid.Institutions{...}]} = Plaid.Institutions.all()
{:error, %Plaid.Error{...}} = Plaid.Institutions.all()
Plaid API Reference: https://plaid.com/docs/api/#all-institutions
Specs
id(binary) :: {atom, map}
Fetchs an institution based on the id.
Returns a specific institution based on the id provided. This endpoint requires no authentication.
Returns a Plaid.Institutions
or Plaid.Error
struct.
Example
{:ok, %Plaid.Institution{...}} = Plaid.Institution.id("55ccd367d32f2fdf19c1c448")
{:error, %Plaid.Error{...}} = Plaid.Institution.id("55ccd367d32f2fdf19c1c448")
Plaid API Reference: https://plaid.com/docs/api/#institutions-by-id
Specs
long_tail(integer, integer) :: {atom, list}
Returns long-tail institutions.
Returns the universe of institutions supported through Plaid’s partnerships. Results are paginated. This endpoint requires authentication; uses credentials supplied in configuration.
Returns list of Plaid.LongTailInstitutions
or Plaid.Error
struct.
The %Plaid.LongTailInstitutions{}
struct does not map all the data elements
returned in the Plaid JSON response. The values ommitted are:
- video
- colors
- logo
- nameBreak
Example
{:ok, [%Plaid.LongTailInstitutions{...}]} = Plaid.Institutions.long_tail(50, 0)
{:error, %Plaid.Error{...}} = Plaid.Institutions.long_tail(50, 0)
Plaid API Reference: https://plaid.com/docs/api/#all-long-tail-institutions
Specs
long_tail(integer, integer, map) :: {atom, list}
Returns long-tail institutions with user-supplied credentials.
Example
cred = %{client_id: "test_id", secret: "test_secret"}
{:ok, [%Plaid.LongTailInstitutions{...}]} = Plaid.Institutions.long_tail(50, 0, cred)
{:error, %Plaid.Error{...}} = Plaid.Institutions.long_tail(50, 0, cred)
Plaid API Reference: https://plaid.com/docs/api/#all-long-tail-institutions
Specs
long_tail_id(binary) :: {atom, list}
Returns a long-tail institution based on the id.
Returns the long-tail institution supported through Plaid’s partnerships based on the id provided. This endpoint requires no authentication.
The %Plaid.LongTailInstitutions{}
struct does not map all the data elements
returned in the Plaid JSON response. The values ommitted are:
- video
- colors
- logo
- nameBreak
Returns a Plaid.LongTailInstitutions
or Plaid.Error
struct.
Example
{:ok, %Plaid.LongTailInstitutions{...}} = Plaid.Institutions.long_tail_id("wells")
{:error, %Plaid.Error{...}} = Plaid.Institutions.long_tail_id("wells")
Plaid API Reference: https://plaid.com/docs/api/#institution-search
Specs
long_tail_search(binary, binary | nil) :: {atom, map}
Returns long-tail institutions based on query parameters.
Returns the list of long-tail institutions supported through Plaid’s partnerships. Long-tail institutions are queried by name using a partial match search and product parameter as options. This endpoint does not require authentication.
The %Plaid.LongTailInstitutions{}
does not map all the data elements returned
in the Plaid JSON response. The values ommitted are:
- video
- colors
- logo
- nameBreak
Returns a list of Plaid.LongTailInstitutions
or Plaid.Error
struct.
Example
{:ok, [%Plaid.LongTailInstitutions{...}]} = Plaid.Institutions.long_tail_search("wells","auth")
{:error, %Plaid.Error{...}} = Plaid.Institutions.long_tail_search("wells","auth")
Plaid API Reference: https://plaid.com/docs/api/#institution-search