Marqeta.Credit.BalanceRefunds (marqeta v1.0.0)

Copy Markdown View Source

Issue balance refunds on a credit account with a negative balance.

Summary

Functions

Creates a balance refund on a credit account.

Creates a balance refund. Raises on error.

Retrieves a balance refund by token.

Retrieves a balance refund. Raises on error.

Lists balance refund records on a credit account.

Lists balance refund records. Raises on error.

Returns a lazy stream of all balance refund records for an account.

Functions

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

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

Creates a balance refund on a credit account.

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

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

Creates a balance refund. Raises on error.

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

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

Retrieves a balance refund by token.

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

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

Retrieves a balance refund. Raises on error.

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

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

Lists balance refund records on a credit account.

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

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

Lists balance refund records. Raises on error.

stream(account_token, params \\ %{})

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

Returns a lazy stream of all balance refund records for an account.