Recurring or future-dated transfers.
Summary
Functions
Cancels a schedule.
Creates a schedule.
Retrieves a schedule.
Gets a single occurrence of a schedule (e.g. "next" or a specific date), per occurrence_filter.
Lists schedules for an account.
Replaces a schedule's configuration.
Functions
@spec cancel(Moov.Client.t(), String.t(), String.t()) :: {:ok, term()} | {:error, Moov.Error.t()}
Cancels a schedule.
@spec create(Moov.Client.t(), String.t(), map()) :: {:ok, map()} | {:error, Moov.Error.t()}
Creates a schedule.
params: :recurrence (e.g. %{interval: "monthly", start_date: "2026-07-01"}),
and the same :source/:destination/:amount shape as
Moov.Transfers.create/4.
@spec get(Moov.Client.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Moov.Error.t()}
Retrieves a schedule.
@spec get_occurrence(Moov.Client.t(), String.t(), String.t(), String.t()) :: {:ok, map()} | {:error, Moov.Error.t()}
Gets a single occurrence of a schedule (e.g. "next" or a specific date), per occurrence_filter.
@spec list(Moov.Client.t(), String.t(), keyword()) :: {:ok, [map()]} | {:error, Moov.Error.t()}
Lists schedules for an account.
@spec update(Moov.Client.t(), String.t(), String.t(), map()) :: {:ok, map()} | {:error, Moov.Error.t()}
Replaces a schedule's configuration.