Marqeta.ProgramTransfers (marqeta v1.0.0)

Copy Markdown View Source

Move funds from a user's GPA back to the program funding source. Used for account closures, chargebacks, and operational transfers.

Summary

Functions

Creates a new program transfer.

Creates a new program transfer. Raises Marqeta.Error on failure.

Creates a program transfer type.

Retrieves a program transfer by token.

Retrieves a program transfer by token. Raises Marqeta.Error on failure.

Retrieves a program transfer type by token.

Lists program transfer resources.

Lists program transfer resources. Raises Marqeta.Error on failure.

Lists program transfer types configured for your program.

Returns a lazy Stream that auto-paginates program transfer resources.

Updates a program transfer type.

Functions

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

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

Creates a new program transfer.

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

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

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

Creates a new program transfer. Raises Marqeta.Error on failure.

create_type(params, opts \\ [])

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

Creates a program transfer type.

get(token, opts \\ [])

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

Retrieves a program transfer by token.

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

get!(token, opts \\ [])

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

Retrieves a program transfer by token. Raises Marqeta.Error on failure.

get_type(type_token, opts \\ [])

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

Retrieves a program transfer type by token.

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

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

Lists program transfer 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 transfer resources. Raises Marqeta.Error on failure.

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

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

Lists program transfer types configured for your program.

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

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

Returns a lazy Stream that auto-paginates program transfer resources.

update_type(type_token, params, opts \\ [])

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

Updates a program transfer type.