Skip to main content
POST
/
v1
/
rules
/
{rule-id}
/
parameters
{
  "entity": {
    "id": "string",
    "type": "CARD"
  },
  "ruleType": "AMOUNT",
  "values": {
    "amount": 100
  }
}

{
  "code": "<string>",
  "message": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "errorCode": "<string>",
  "errorType": "STATIC_VALIDATION_ERROR",
  "errorReason": "<string>",
  "timestamp": "2023-11-07T05:31:56Z"
}
{
  "entity": {
    "id": "string",
    "type": "CARD"
  },
  "ruleType": "AMOUNT",
  "values": {
    "amount": 100
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
rule-id
string<biginteger>
required

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 Countries
  • Blocked Countries
  • Cardholder Present
  • Cumulative Individual Limits
  • Cumulative Individual Limits
​
values
object
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"

​
entity
object
required

Response

Successful operation