Marqeta.CommandoMode (marqeta v1.0.0)

Commando Mode is a fallback decision system that activates when your Gateway JIT endpoint is unreachable or too slow.

Pre-configure rules (approve all / decline all / approve by MCC) so transactions can proceed even during gateway outages.

Examples

# View current commando mode status
{:ok, status} = Marqeta.CommandoMode.get("commando_token")

# List control sets
{:ok, sets} = Marqeta.CommandoMode.list_control_sets()

# Create a control set
{:ok, cs} = Marqeta.CommandoMode.create_control_set(%{
  name: "Allow Groceries",
  control: %{
    transaction_type: %{
      include_purchases: true
    },
    merchant_scope: %{
      mcc_group: "grocery_mcc_group"
    }
  }
})

Summary

Functions

addendum(token, opts \\ [])

Retrieves the commando mode addendum (extended configuration).

create_control_set(params, opts \\ [])

Creates a commando mode control set.

disable(token, opts \\ [])

Disables commando mode for the program.

enable(token, opts \\ [])

Enables commando mode for the program.

get(token, opts \\ [])

Retrieves a commando mode by token.

get!(token, opts \\ [])

Retrieves a commando mode by token. Raises Marqeta.Error on failure.

get_control_set(token, opts \\ [])

Retrieves a commando mode control set by token.

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

Retrieves all commando mode entries.

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

Lists commando mode control sets.

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

Updates an existing commando mode.

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

Updates an existing commando mode. Raises Marqeta.Error on failure.

update_addendum(token, params, opts \\ [])

Updates the commando mode addendum.

update_control_set(token, params, opts \\ [])

Updates a commando mode control set.

Functions

addendum(token, opts \\ [])

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

Retrieves the commando mode addendum (extended configuration).

create_control_set(params, opts \\ [])

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

Creates a commando mode control set.

disable(token, opts \\ [])

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

Disables commando mode for the program.

enable(token, opts \\ [])

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

Enables commando mode for the program.

get(token, opts \\ [])

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

Retrieves a commando mode by token.

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

get!(token, opts \\ [])

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

Retrieves a commando mode by token. Raises Marqeta.Error on failure.

get_control_set(token, opts \\ [])

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

Retrieves a commando mode control set by token.

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

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

Retrieves all commando mode entries.

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

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

Lists commando mode control sets.

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

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

Updates an existing commando mode.

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

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

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

Updates an existing commando mode. Raises Marqeta.Error on failure.

update_addendum(token, params, opts \\ [])

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

Updates the commando mode addendum.

update_control_set(token, params, opts \\ [])

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

Updates a commando mode control set.