Tink.Providers (Tink v1.0.0)

Copy Markdown View Source

Bank provider directory. Requires providers:read scope.

Provider lists are cached globally (not per-user) since they are the same for all users: list_for_market is cached 2h, list_markets cached 2h.

Summary

Functions

Get a single provider by name. Cached 1h globally.

Get auth options for a specific provider. Requires providers:read.

Get auth options for all providers in a market. Requires providers:read.

List providers for a market. Cached 2h globally per market.

List all provider identifiers. Requires providers:read.

List all markets with providers. Cached 2h globally.

Functions

get(client, provider_name)

@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

Get a single provider by name. Cached 1h globally.

get_auth_options(client, provider_name)

@spec get_auth_options(Tink.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Get auth options for a specific provider. Requires providers:read.

get_auth_options_for_market(client, market)

@spec get_auth_options_for_market(Tink.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Get auth options for all providers in a market. Requires providers:read.

list_for_market(client, market, opts \\ [])

@spec list_for_market(Tink.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

List providers for a market. Cached 2h globally per market.

list_identifiers(client)

@spec list_identifiers(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List all provider identifiers. Requires providers:read.

list_markets(client)

@spec list_markets(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List all markets with providers. Cached 2h globally.