Skip to main content
POST
/
v1
/
rules
{
  "defaultParameters": {
    "amount": 100
  },
  "filterOperatorType": "ANY",
  "name": "string",
  "ruleSetId": "string",
  "ruleType": "AMOUNT"
}

{
  "defaultParameters": {
    "amount": 100
  },
  "filterOperatorType": "ANY",
  "filters": [
    {
      "id": "string",
      "reversed": true,
      "type": "MCC"
    }
  ],
  "id": "string",
  "name": "string",
  "ruleType": "AMOUNT"
}

{
  "defaultParameters": {
    "amount": 100
  },
  "filterOperatorType": "ANY",
  "name": "string",
  "ruleSetId": "string",
  "ruleType": "AMOUNT"
}

{
  "defaultParameters": {
    "amount": 100
  },
  "filterOperatorType": "ANY",
  "filters": [
    {
      "id": "string",
      "reversed": true,
      "type": "MCC"
    }
  ],
  "id": "string",
  "name": "string",
  "ruleType": "AMOUNT"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
auditUser
string
required

The audit user to log the request

Body

application/json
  • Amount
  • Allowed Merchants
  • Blocked Merchants
  • Allowed Card Entry Modes
  • Blocked Card Entry Modes
  • Allowed MCCs
  • Blocked MCCs
  • Allowed CVMs
  • Blocked CVMs
  • Allowed Merchant Countries
  • Blocked Merchant Countries
  • Cardholder Present
  • Decline
  • External Balance Check
  • Cumulative Amount Individual Limit
  • Cumulative Count Individual Limit
  • Enfuce Internal PSD2 Pin Count Rule
  • Enfuce Internal PSD2 Pin Amount Rule
​
ruleSetId
string<biginteger>
required
​
ruleType
enum<string>
default:AMOUNT
required

DECLINE

Always declines. Should be used together with filters. Parameters: None

ALLOWED_MCC

Approves if MCC in request is in parameter list. Otherwise declines. Parameters: List of MCC codes

BLOCKED_MCC

Declines if MCC in request is in parameter list. Otherwise approves. Parameters: List of MCC codes

ALLOWED_MERCHANT_ID

Approves if merchant id in request is in parameter list. Otherwise declines. Parameters: List of merchant ids

BLOCKED_MERCHANT_ID

Declines if merchant id in request is in parameter list. Otherwise approves. Parameters: List of merchant ids

AMOUNT

Declines if amount in request is greater than the parameter. Otherwise approves. Parameters: Single element containing floating number

ALLOWED_MERCHANT_COUNTRY

Approves if country code in request is not present or is in parameter list. Otherwise declines. Parameters: List of country codes

BLOCKED_MERCHANT_COUNTRY

Declines if country code in request is present and is in parameter list. Otherwise approves. Parameters: List of country codes

BLOCKED_CARD_ENTRY_MODES

Declines if card entry mode code in request is present and is in parameter list. Otherwise approves. Parameters: List of card entry mode codes

ALLOWED_CARD_ENTRY_MODES

Approves if card entry mode code in request is present and is in parameter list. Otherwise declines. Parameters: List of card entry mode codes

ALLOWED_CVM

Approves if cardholder verification code in request is present and is in parameter list. Otherwise declines. Parameters: List of cardholder verification codes

BLOCKED_CVM

Declines if cardholder verification code in request is present and is in parameter list. Otherwise approves. Parameters: List of cardholder verification codes

EXTERNAL_BALANCE_CHECK

Declines if account balance is lower than transaction amount. Otherwise approves. Parameters: None

CUMULATIVE_AMOUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative amount over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

CUMULATIVE_COUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative count over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

ENFUCE_INTERNAL_PSD2_PIN_COUNT_RULE

This ruleType is for internal enfuce use only

ENFUCE_INTERNAL_PSD2_PIN_AMOUNT_RULE

This ruleType is for internal enfuce use only

DECLINE

Always declines. Should be used together with filters. Parameters: None

ALLOWED_MCC

Approves if MCC in request is in parameter list. Otherwise declines. Parameters: List of MCC codes

BLOCKED_MCC

Declines if MCC in request is in parameter list. Otherwise approves. Parameters: List of MCC codes

ALLOWED_MERCHANT_ID

Approves if merchant id in request is in parameter list. Otherwise declines. Parameters: List of merchant ids

BLOCKED_MERCHANT_ID

Declines if merchant id in request is in parameter list. Otherwise approves. Parameters: List of merchant ids

AMOUNT

Declines if amount in request is greater than the parameter. Otherwise approves. Parameters: Single element containing floating number

ALLOWED_MERCHANT_COUNTRY

Approves if country code in request is not present or is in parameter list. Otherwise declines. Parameters: List of country codes

BLOCKED_MERCHANT_COUNTRY

Declines if country code in request is present and is in parameter list. Otherwise approves. Parameters: List of country codes

BLOCKED_CARD_ENTRY_MODES

Declines if card entry mode code in request is present and is in parameter list. Otherwise approves. Parameters: List of card entry mode codes

ALLOWED_CARD_ENTRY_MODES

Approves if card entry mode code in request is present and is in parameter list. Otherwise declines. Parameters: List of card entry mode codes

ALLOWED_CVM

Approves if cardholder verification code in request is present and is in parameter list. Otherwise declines. Parameters: List of cardholder verification codes

BLOCKED_CVM

Declines if cardholder verification code in request is present and is in parameter list. Otherwise approves. Parameters: List of cardholder verification codes

EXTERNAL_BALANCE_CHECK

Declines if account balance is lower than transaction amount. Otherwise approves. Parameters: None

CUMULATIVE_AMOUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative amount over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

CUMULATIVE_COUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative count over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

ENFUCE_INTERNAL_PSD2_PIN_COUNT_RULE

This ruleType is for internal enfuce use only

ENFUCE_INTERNAL_PSD2_PIN_AMOUNT_RULE

This ruleType is for internal enfuce use only

Available options:
DECLINE,
ALLOWED_MCC,
BLOCKED_MCC,
ALLOWED_MERCHANT_ID,
BLOCKED_MERCHANT_ID,
AMOUNT,
ALLOWED_MERCHANT_COUNTRY,
BLOCKED_MERCHANT_COUNTRY,
ALLOWED_CARD_ENTRY_MODES,
BLOCKED_CARD_ENTRY_MODES,
ALLOWED_CVM,
BLOCKED_CVM,
CARDHOLDER_PRESENT,
EXTERNAL_BALANCE_CHECK,
CUMULATIVE_AMOUNT_INDIVIDUAL_LIMITS,
CUMULATIVE_COUNT_INDIVIDUAL_LIMITS,
ENFUCE_INTERNAL_PSD2_PIN_COUNT_RULE,
ENFUCE_INTERNAL_PSD2_PIN_AMOUNT_RULE
Example:

"AMOUNT"

​
name
string
required
​
filterOperatorType
enum<string>
required

Defines whether all filters should match or if it's for just one filter to pass. Defines whether all filters should match or if it's for just one filter to pass.

Available options:
ANY,
ALL
​
defaultParameters
object

Response

Successful operation

​
name
string
required
​
filterOperatorType
enum<string>
required

Defines whether all filters should match or if it's for just one filter to pass.

Available options:
ANY,
ALL
​
id
string<biginteger>
​
ruleType
enum<string>

DECLINE

Always declines. Should be used together with filters. Parameters: None

ALLOWED_MCC

Approves if MCC in request is in parameter list. Otherwise declines. Parameters: List of MCC codes

BLOCKED_MCC

Declines if MCC in request is in parameter list. Otherwise approves. Parameters: List of MCC codes

ALLOWED_MERCHANT_ID

Approves if merchant id in request is in parameter list. Otherwise declines. Parameters: List of merchant ids

BLOCKED_MERCHANT_ID

Declines if merchant id in request is in parameter list. Otherwise approves. Parameters: List of merchant ids

AMOUNT

Declines if amount in request is greater than the parameter. Otherwise approves. Parameters: Single element containing floating number

ALLOWED_MERCHANT_COUNTRY

Approves if country code in request is not present or is in parameter list. Otherwise declines. Parameters: List of country codes

BLOCKED_MERCHANT_COUNTRY

Declines if country code in request is present and is in parameter list. Otherwise approves. Parameters: List of country codes

BLOCKED_CARD_ENTRY_MODES

Declines if card entry mode code in request is present and is in parameter list. Otherwise approves. Parameters: List of card entry mode codes

ALLOWED_CARD_ENTRY_MODES

Approves if card entry mode code in request is present and is in parameter list. Otherwise declines. Parameters: List of card entry mode codes

ALLOWED_CVM

Approves if cardholder verification code in request is present and is in parameter list. Otherwise declines. Parameters: List of cardholder verification codes

BLOCKED_CVM

Declines if cardholder verification code in request is present and is in parameter list. Otherwise approves. Parameters: List of cardholder verification codes

EXTERNAL_BALANCE_CHECK

Declines if account balance is lower than transaction amount. Otherwise approves. Parameters: None

CUMULATIVE_AMOUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative amount over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

CUMULATIVE_COUNT_INDIVIDUAL_LIMITS - Work in Progress

Declines if cumulative count over the defined period of time exceeds the parameter. Otherwise approves. Parameters: Single element containing floating number (limit), enumerated period of time string and single element elaborating on the period length for rolling periods

ENFUCE_INTERNAL_PSD2_PIN_COUNT_RULE

This ruleType is for internal enfuce use only

ENFUCE_INTERNAL_PSD2_PIN_AMOUNT_RULE

This ruleType is for internal enfuce use only

Available options:
DECLINE,
ALLOWED_MCC,
BLOCKED_MCC,
ALLOWED_MERCHANT_ID,
BLOCKED_MERCHANT_ID,
AMOUNT,
ALLOWED_MERCHANT_COUNTRY,
BLOCKED_MERCHANT_COUNTRY,
ALLOWED_CARD_ENTRY_MODES,
BLOCKED_CARD_ENTRY_MODES,
ALLOWED_CVM,
BLOCKED_CVM,
CARDHOLDER_PRESENT,
EXTERNAL_BALANCE_CHECK,
CUMULATIVE_AMOUNT_INDIVIDUAL_LIMITS,
CUMULATIVE_COUNT_INDIVIDUAL_LIMITS,
ENFUCE_INTERNAL_PSD2_PIN_COUNT_RULE,
ENFUCE_INTERNAL_PSD2_PIN_AMOUNT_RULE
​
filters
object[]