Marqeta.ProgramReserve (marqeta v1.0.0)

Copy Markdown View Source

Manage your program reserve account — the pool of funds your program operates from. Credit and debit the reserve, and query its balance.

Summary

Functions

Returns the current program reserve balance.

Creates a new program reserve transaction.

Creates a new program reserve transaction. Raises Marqeta.Error on failure.

Retrieves a program reserve transaction by token.

Retrieves a program reserve transaction by token. Raises Marqeta.Error on failure.

Lists program reserve transaction resources.

Lists program reserve transaction resources. Raises Marqeta.Error on failure.

Returns a lazy Stream that auto-paginates program reserve transaction resources.

Functions

balance(opts \\ [])

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

Returns the current program reserve balance.

create(params \\ %{}, opts \\ [])

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

Creates a new program reserve transaction.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

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

@spec create!(
  map(),
  keyword()
) :: map()

Creates a new program reserve transaction. Raises Marqeta.Error on failure.

get(token, opts \\ [])

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

Retrieves a program reserve transaction by token.

Returns {:ok, map()} on success, {:error, %Marqeta.Error{}} on failure.

get!(token, opts \\ [])

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

Retrieves a program reserve transaction by token. Raises Marqeta.Error on failure.

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

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

Lists program reserve transaction resources.

Accepts standard Marqeta pagination params: count, start_index, sort_by, sort_order, fields.

Use stream/2 to lazily iterate all pages automatically.

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

@spec list!(
  map(),
  keyword()
) :: map()

Lists program reserve transaction resources. Raises Marqeta.Error on failure.

stream(params \\ %{}, opts \\ [])

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

Returns a lazy Stream that auto-paginates program reserve transaction resources.