PreRule

Type: Struct

Abstract: no

Status: Active

Java Class: PreRule

Set of rules to validate billing address, issuing bank country, BIN

Available Fields:

actionType
amount
billingCountryCodeList

billingStateCodeList
cardTypeList
id

isActive
issuingCountryCodeList
operatorType

priority
userMessage

References: Pre Rule.Id

XML Representation: attribute

Attributes:

Default Value

Identifier of the object used for references; auto-incremented integer value.

isActive

References: Pre Rule.Is Active

XML Representation: attribute

Attributes:

Default Value

Field that shows whether the pre-processing rule is active within the system.

Indicates whether the rule is active within the system. The values can be the following:
'true' - the rule is active
'false' - the rule is inactive

billingCountryCodeList

References: Pre Rule.Billing Country Code List

XML Representation: attribute

Attributes:

Default Value

List of countries regulated by the pre-processing rule.

billingStateCodeList

References: Pre Rule.Billing State Code List

XML Representation: attribute

Attributes:

Default Value

List of states regulated by the pre-processing rule.

issuingCountryCodeList

References: Pre Rule.Issuing Country Code List

XML Representation: attribute

Attributes:

Default Value

List of card issuing countries regulated by the pre-processing rule.

cardTypeList

References: Pre Rule.Card Type List

XML Representation: attribute

Attributes:

Default Value

List of card types regulated by the pre-processing rule. Rule can be applied to either credit or debit card.

Card types included in pre-processing validation. The values can be the following:
'Credit' - credit cards included
'Debit (not regulated)' - not regulated debit cards
'Debit (regulated)' - regulated debit cards

actionType

References: Pre Rule.Rule Action CL

XML Representation: attribute

Attributes:

Default Value

Represents further behavior after a pre-processing rule was applied to the transaction. It can be either accepted of declined.

Result action of the post-processing rule. The values can be the following:
'A' - accept the transaction
'R' - reject the transaction

operatorType

References: Pre Rule.Rule Operator CL

XML Representation: attribute

Attributes:

Default Value

Represents current usage status associated with the rule within the system.

amount

References: Pre Rule.Amount

XML Representation: attribute

Attributes:

Default Value

Element that defines the amount of the transaction. Value must be submitted in cents without a decimal point.

userMessage

References: Pre Rule.User Message

XML Representation: attribute

Attributes:

Default Value

Message that will be shown for rejected transactions.

priority

Type: Integer

XML Representation: attribute

Attributes:

Default Value

Priority of the post-processing rule.

XML Sample:

<pre-rule id="2000"  isActive="true"  billingCountryCodeList="US, CA, AU"  billingStateCodeList="WA, AL"  issuingCountryCodeList="US, CA, AU"  cardTypeList="Credit, Debit(regulated)"  actionType="A"  operatorType="NU"  amount="100"  userMessage="Test pre-rule response message" />

"<pre-rule id=\"2000\" isActive=\"true\" billingCountryCodeList=\"US, CA, AU\" billingStateCodeList=\"WA, AL\" issuingCountryCodeList=\"US, CA, AU\" cardTypeList=\"Credit, Debit(regulated)\" actionType=\"A\" operatorType=\"NU\" amount=\"100\" userMessage=\"Test pre-rule response message\" />"

JSON Sample:

{
  "id": "2000",
  "isActive": true,
  "billingCountryCodeList": "US, CA, AU",
  "billingStateCodeList": "WA, AL",
  "issuingCountryCodeList": "US, CA, AU",
  "cardTypeList": "Credit, Debit(regulated)",
  "actionType": "A",
  "operatorType": "NU",
  "amount": "100",
  "userMessage": "Test pre-rule response message"
}

XURL Sample:

?id=2000&isActive=true&billingCountryCodeList=US%2C+CA%2C+AU&billingStateCodeList=WA%2C+AL&issuingCountryCodeList=US%2C+CA%2C+AU&cardTypeList=Credit%2C+Debit%28regulated%29&actionType=A&operatorType=NU&amount=100&userMessage=Test+pre-rule+response+message&

id=2000
isActive=true
billingCountryCodeList=US, CA, AU
billingStateCodeList=WA, AL
issuingCountryCodeList=US, CA, AU
cardTypeList=Credit, Debit(regulated)
actionType=A
operatorType=NU
amount=100
userMessage=Test pre-rule response message