Tink.BalanceCheck (Tink v1.0.0)

Copy Markdown View Source

Balance refresh — trigger and poll real-time balance pulls. Requires balance-refresh and balance-refresh:readonly scopes.

Summary

Functions

Get the status of a balance refresh by refresh ID. Requires balance-refresh:readonly.

Poll a balance refresh until complete or timed out.

Trigger a balance refresh. Requires balance-refresh.

Functions

get_refresh_status(client, refresh_id)

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

Get the status of a balance refresh by refresh ID. Requires balance-refresh:readonly.

poll_until_complete(client, refresh_id, opts \\ [])

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

Poll a balance refresh until complete or timed out.

Options

  • :timeout_ms — default 30_000
  • :interval_ms — default 1_000

trigger_refresh(client, params \\ %{})

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

Trigger a balance refresh. Requires balance-refresh.