Marqeta.Credit.PaymentSchedules (marqeta v1.0.0)

Copy Markdown View Source

Schedule one-time or recurring payments on a credit account.

Summary

Functions

Creates a payment schedule on a credit account.

Creates a payment schedule. Raises on error.

Deletes a payment schedule.

Retrieves a payment schedule by token.

Retrieves a payment schedule. Raises on error.

Lists payment schedule records on a credit account.

Lists payment schedule records. Raises on error.

Returns a lazy stream of all payment schedule records for an account.

Updates a payment schedule. Raises on error.

Functions

create(account_token, params, opts \\ [])

@spec create(String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Creates a payment schedule on a credit account.

create!(account_token, params, opts \\ [])

@spec create!(String.t(), map(), keyword()) :: map()

Creates a payment schedule. Raises on error.

delete(account_token, token, opts \\ [])

@spec delete(String.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Deletes a payment schedule.

get(account_token, token, opts \\ [])

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

Retrieves a payment schedule by token.

get!(account_token, token, opts \\ [])

@spec get!(String.t(), String.t(), keyword()) :: map()

Retrieves a payment schedule. Raises on error.

list(account_token, params \\ %{}, opts \\ [])

@spec list(String.t(), map(), keyword()) :: {:ok, map()} | {:error, Marqeta.Error.t()}

Lists payment schedule records on a credit account.

list!(account_token, params \\ %{}, opts \\ [])

@spec list!(String.t(), map(), keyword()) :: map()

Lists payment schedule records. Raises on error.

stream(account_token, params \\ %{})

@spec stream(String.t(), map()) :: Enumerable.t()

Returns a lazy stream of all payment schedule records for an account.

update(account_token, token, params, opts \\ [])

@spec update(String.t(), String.t(), map(), keyword()) ::
  {:ok, map()} | {:error, Marqeta.Error.t()}

Updates a payment schedule.

update!(account_token, token, params, opts \\ [])

@spec update!(String.t(), String.t(), map(), keyword()) :: map()

Updates a payment schedule. Raises on error.