Tink.MandatePayments (Tink v1.0.0)

Copy Markdown View Source

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

create(client, params)

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

Create a mandate payment (v2). Requires mandate-payments.

create_v1(client, params)

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

Create a mandate payment (v1). Requires mandate-payments.

get(client, id)

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

Get a mandate payment by ID (v2). Requires mandate-payments:readonly.

get_v1(client, id)

@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.

poll_until_terminal(client, id, opts \\ [])

@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