Mandate-based recurring payments (v1 and v2).
Requires mandate-payments and mandate-payments:readonly scopes.
Summary
Functions
Create a mandate payment (v2). Requires mandate-payments.
Create a mandate payment (v1). Requires mandate-payments.
Get a mandate payment by ID (v2). Requires mandate-payments:readonly.
Get a mandate payment by ID (v1). Requires mandate-payments:readonly.
Poll a mandate payment until terminal status.
Functions
@spec create(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Create a mandate payment (v2). Requires mandate-payments.
@spec create_v1(Tink.Client.t(), map()) :: {:ok, map()} | {:error, Tink.Error.t()}
Create a mandate payment (v1). Requires mandate-payments.
@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Get a mandate payment by ID (v2). Requires mandate-payments:readonly.
@spec get_v1(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}
Get a mandate payment by ID (v1). Requires mandate-payments:readonly.
@spec poll_until_terminal(Tink.Client.t(), String.t(), keyword()) :: {:ok, map()} | {:error, Tink.Error.t() | :timeout}
Poll a mandate payment until terminal status.
Options
:timeout_ms— default 60_000:interval_ms— default 2_000