Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Rules Endpoints

Get Parameters

This operation retrieves parameters for particular rule

get/v1/rules/{rule-id}/parameters

Path parameters

rule-idstring biginteger required

Query parameters

entity-idstring required

The unique identifier of the entity to which the rule or parameter should be associated. This can be either a card ID or a hierarchy group ID.

entity-type'CARD' | 'CARD_HIERARCHY_GROUP' required
ruleset-type'STANDARD' | 'STIP'

STANDARD

STIP

auditUserstring required

The audit user to log the request

Response

Get parameters success response

ruleType'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' 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