Marqeta.AuthorizationControls (marqeta v1.0.0)

Rule-based controls that restrict which merchants cardholders can transact with.

Supports MCC codes, merchant groups, specific merchant IDs, and geographic restrictions (country-level).

Examples

# Block all gambling MCCs for a card product
{:ok, _} = Marqeta.AuthorizationControls.create(%{
  name: "No Gambling",
  association: %{card_product_token: "cp_01"},
  merchant_scope: %{mcc_group: "gambling_mccs"},
  active: true
})

Summary

Functions

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

Adds an exemption to an authorization control.

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

Creates a new authorization control.

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

Creates a new authorization control. Raises Marqeta.Error on failure.

get(token, opts \\ [])

Retrieves a authorization control by token.

get!(token, opts \\ [])

Retrieves a authorization control by token. Raises Marqeta.Error on failure.

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

Lists authorization control resources.

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

Lists authorization control resources. Raises Marqeta.Error on failure.

list_exemptions(token, params \\ %{}, opts \\ [])

Lists exemptions configured on an authorization control.

remove_exemption(control_token, exemption_token, opts \\ [])

Removes an exemption from an authorization control.

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

Returns a lazy Stream that auto-paginates authorization control resources.

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

Updates an existing authorization control.

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

Updates an existing authorization control. Raises Marqeta.Error on failure.

Functions

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

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

Adds an exemption to an authorization control.

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

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

Creates a new authorization control.

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

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

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

Creates a new authorization control. Raises Marqeta.Error on failure.

get(token, opts \\ [])

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

Retrieves a authorization control by token.

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

get!(token, opts \\ [])

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

Retrieves a authorization control by token. Raises Marqeta.Error on failure.

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

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

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

list_exemptions(token, params \\ %{}, opts \\ [])

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

Lists exemptions configured on an authorization control.

remove_exemption(control_token, exemption_token, opts \\ [])

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

Removes an exemption from an authorization control.

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

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

Returns a lazy Stream that auto-paginates authorization control resources.

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

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

Updates an existing authorization control.

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

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

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

Updates an existing authorization control. Raises Marqeta.Error on failure.