Marqeta.ACHReceiving (marqeta v1.0.0)

Copy Markdown View Source

Enable third-party ACH credits and debits directly to account holder GPAs. Supports inbound ACH pull and push payments.

Summary

Functions

Retrieves ACH receiving configuration.

Creates a new ACH receiving transfer.

Creates a new ACH receiving transfer. Raises Marqeta.Error on failure.

Creates an ACH receiving transfer type.

Retrieves a ACH receiving transfer by token.

Retrieves a ACH receiving transfer by token. Raises Marqeta.Error on failure.

Lists ACH receiving transfer resources.

Lists ACH receiving transfer resources. Raises Marqeta.Error on failure.

Lists ACH receiving transfer types.

Returns a lazy Stream that auto-paginates ACH receiving transfer resources.

Updates ACH receiving configuration.

Functions

config(opts \\ [])

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

Retrieves ACH receiving configuration.

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

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

Creates a new ACH receiving transfer.

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

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

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

Creates a new ACH receiving transfer. Raises Marqeta.Error on failure.

create_type(params, opts \\ [])

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

Creates an ACH receiving transfer type.

get(token, opts \\ [])

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

Retrieves a ACH receiving transfer by token.

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

get!(token, opts \\ [])

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

Retrieves a ACH receiving transfer by token. Raises Marqeta.Error on failure.

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

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

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

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

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

Lists ACH receiving transfer types.

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

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

Returns a lazy Stream that auto-paginates ACH receiving transfer resources.

update_config(params, opts \\ [])

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

Updates ACH receiving configuration.