Worked Examples

Rule for All Transactions in a Period

In this example, you can extend the basic rule that you created in the first example to create an Entity State that collects data of all ATM transactions in the last 30 days for a token.

Details of the Entity State

The state includes the following conditions:

• Identifying if the transaction took place outside of the country.

• Identifying if the billing amount of the ATM transaction exceeds 30 in the last 30 days.

• Indicating if the MCC code is 6011.

The state also include a histogram for analysing the data over time. The histogram includes a bucket size in order to collect the accumulated values every 2 days.

Details of the Rule

When you've specified the state, you can create a rule that uses the data in the state. In this example, the rule creates an alert (by using the @alert annotation). The rule contains the following information:

• eventType is cardRT or cardNRT.

• The MCC in the rule is 6011.

• Transactions are through an ATM where the cumulative value of all ATM transactions in the last 30 days is greater than 1000.

• The token is not listed in the whitelistedCards data list.

Create a Rule

You need to include details of the state in its own directory, and then create the rule. In addition, the name of the state must be unique.

1. If a directory for the state doesn't exist, create a directory.
1. Click Create Directory.
2. In the displayed window, enter a suitable name (for example Entity State) in Directory Name and click Create.
2. When you have created the directory, click Create Definition and select the created directory.

   

3. Click Create.
4. Type in the following in the blank rule block.
   Copy

   @eventType("cardRT")
   @eventType("cardNRT")
   @histogram(historyLength=30d, bucketSize=1d)
   state.ATM_History30days: 
   (event.cardCountryCode != event.merchantCountry) &&
   event.amount.baseValue > 30 &&
   (event.merchantCategoryCode == "6011") ? event.amount.baseValue
   
                       

5. Click Save.
6. When you have created the state, create the rule in the cardEntityId directory in the blank rule block.
   Copy

   @alert
   @eventType("cardRT")
   @eventType("cardNRT")
   rules.RuleExample2:
   event.merchantCategoryCode == "6011" &&
   lists.whitelistedCards !# event.cardId &&
   ((state.ATM_History30days.total(30d) ?? 0) + event.amount.baseValue) > 1000
                       

7. Click Save to create the rule in staging. When you have saved the rule, you can perform unit tests.

Run Unit Tests

1. Open the created rule and click Tests.

   

2. Click + under the Tests options to add a new unit test.
3. Click New test.
4. Click Event generator from the input event (JSON) section.

   

5. From the Event Generator window, select the event type as CardRT or CardNRT from the Type menu.

   

6. Keep the populated mandatory and non-mandatory values for generating an event.
7. In this example, enter a baseValue of over 1000. Ensure that you set the mccEntityId to 6011. You can refer to the following JSON example to ensure that the values match:
   Copy

   {
     "amount": {
       "baseCurrency": "baseCurrency_1",
       "baseValue": 2000,
       "currency": "currency_1",
       "value": 994.8
     },
     "cardEntityId": "cardEntityId_1",
     "cardId": "cardId_1",
     "cardProductType": "cardProductType_1",
     "direction": "inbound",
     "eventId": "eventId_1",
     "eventTime": "2024-05-28T18:05:01.058Z",
     "eventType": "cardRT",
     "fromId": "fromId_1",
     "localDateTime": "2024-05-28T18:05:01.058Z",
     "mccEntityId": "6011",
     "merchantCategoryCode": "merchantCategoryCode_1",
     "msgStatus": "msgStatus_1",
     "msgType": "msgType_1",
     "schemaVersion": 1,
     "tenantId": "tenantId_1",
     "toId": "toId_1",
     "transactionId": "transactionId_1",
     "transactionType": "transactionType_1"
   }

8. In the Initial state area, add the condition to test the state used in the rule.
   Copy

   @histogram(bucketSize = 1d, historyLength = 30d)
   state. ATM_History30days: {
   "data": {
   "2023-03-21": { "size":0, "total":850}
   }}
   

9. Under the Check Rule list, select Check triggers. Check triggers tests that there is a positive outcome, while Check does not trigger, checks for a negative outcome.
10. Click Run tests. If the test is successful, a tick appears in the Results pane.
11. Click Save to save the test.

Rule for All Transactions at a Merchant

In this example, you create a rule that has an Entity State for collecting data of all transactions at Car Rental Agencies (MCC 7512) over the last 30 days in a token.

Details of the Entity State

The state includes the following conditions:

• the eventType is cardRT or cardNRT.

• the MCC code is 7512.

• There are five or more transactions for the token associated with the 7512 MCC code in the last 30 days.

The state also includes a histogram for analysing the data over time. The histogram includes a bucket size in order to collect the accumulated values every day for the 30 day period.

Details of the Rule

The rule includes all the above information of the entity state. However, the token is used 5 or more times for a Card Present transaction.

Create a Rule

The Entity State needs to be in its directory. You can use the Entity States directory that you created in the second example.

1. Click Create Definition.

   

2. Select the directory for the Entity you would like the state to be under. For example if you want the state to trigger for a card, you select cardEntityId > Entity States and click Create.
3. In the blank rule block that appears when you have selected the destination directory of the state, enter details of the state.
   Copy

   @eventType("cardRT")
   @eventType("cardNRT")
   @histogram(historyLength=30d, bucketSize=1d)
   state.Txn_at_MCC7512_30d: 
       event.msgType.lowercase() == "authorization" &&
   (event.merchantCategoryCode == "7512") ? Event.amount.baseValue
   
   

4. When you have created the state, create the rule in the cardEntityId directory in the blank rule block that appears.
5. Enter details of the rule.
   Copy

   @alert
   @eventType("cardRT")
   @eventType("cardNRT")
   rules.RuleExample3: 
   event.msgType.lowercase() == "authorization" &&
   event.merchantCategoryCode == "7512" &&
   !event.pointOfServiceContext.cardPresent &&
   ((state.Txn_at_MCC7512_30d.size(30d) ?? 0) + 1 >= 5)
   

Run Unit Tests

1. Open the created rule and click Tests.

   

2. Click + under the Tests options to add a new unit test.
3. Click New test.
4. Click Event generator from the input event (JSON) section.

   

5. From the Event Generator window, select the event type as CardRT from the Type menu.
6. Keep the populated mandatory and non-mandatory values for generating an event. These values match the following JSON.
   Copy

   
     "amount": {
       "baseCurrency": "baseCurrency_1",
       "baseValue": 1001,
       "currency": "currency_1",
       "value": 0
     },
     "cardEntityId": "cardEntityId_1",
     "cardId": "cardId_1",
     "cardProductType": "cardProductType_1",
     "direction": "inbound",
     "eventId": "eventId_1",
     "eventTime": "2024-05-28T22:18:24.237Z",
     "eventType": "cardRT",
     "fromId": "fromId_1",
     "localDateTime": "2024-05-28T22:18:24.237Z",
     "mccEntityId": "6011",
     "merchantCategoryCode": "merchantCategoryCode_1",
     "msgStatus": "msgStatus_1",
     "msgType": "msgType_1",
     "schemaVersion": 1,
     "tenantId": "tenantId_1",
     "toId": "toId_1",
     "transactionId": "transactionId_1",
     "transactionType": "transactionType_1"
   }

7. In the Initial state area, add the conditions to test the state used in the rule.
   Copy

   @histogram(bucketSize = 1d, historyLength = 30d)
   state.Txn_at_MCC7512_30d: {
   "data": {
   "2024-04-09": { "size":4, "total":500}
   }}
   

8. Under the Check Rule list, select Check triggers.
9. Click Run tests. If the test is successful, a tick appears in the Results pane.
10. Click Save to save the test.