PlaidEx.API.Institutions (plaid_ex v1.0.0)

Copy Markdown View Source

Plaid Institutions API — search and retrieve institution metadata.

Summary

Functions

get(config, institution_id, country_codes \\ ["US"], opts \\ [])

Retrieves a single institution by ID.

list(config, opts \\ [])

Lists institutions with pagination.

search(config, query, opts \\ [])

Searches institutions by name or routing number.

Functions

get(config, institution_id, country_codes \\ ["US"], opts \\ [])

@spec get(PlaidEx.Config.t(), String.t(), [String.t()], keyword()) ::
  {:ok, PlaidEx.Schemas.Institution.t()} | {:error, PlaidEx.Error.t()}

Retrieves a single institution by ID.

list(config, opts \\ [])

@spec list(
  PlaidEx.Config.t(),
  keyword()
) ::
  {:ok, %{institutions: [PlaidEx.Schemas.Institution.t()], total: integer()}}
  | {:error, PlaidEx.Error.t()}

Lists institutions with pagination.

search(config, query, opts \\ [])

@spec search(PlaidEx.Config.t(), String.t(), keyword()) ::
  {:ok, %{institutions: [PlaidEx.Schemas.Institution.t()]}}
  | {:error, PlaidEx.Error.t()}

Searches institutions by name or routing number.