Skip to main content

Metrics Guide

🧩 Rule Filter fields

Overview

There are three rule types:

  • Interval Transaction: Standard rule type. A notification is triggered whenever the specified condition is met and after interval time

  • Single Transaction: Rules applied to individual transactions. Each incoming transaction is evaluated independently against these criteria. And after each 5 minutes

  • Sequential Transaction: Rules that trigger notifications based on a sequence of repeated failures, helping detect issues earlier and improve response time. Required data category which will be used to track and evaluate sequential transaction failures. This determines which table the system will query when checking for consecutive failures.

image-20260304-091952.png

Filter Fields

Field Name

Options

Required

Notes

Time Interval

5 Mins | 1H | 12H | 1D

Required

Time window to evaluate metrics

Merchant ID

API (Org’s resources)

Optional

Filter by merchant(s).

PSP

API (Org’s resources)

Optional

Filter by payment service provider(s).

Country

API (Org’s resources)

Optional

Filter by end-user country (ISO alpha-3).

BIN

API (Org’s resources)

Optional

Filter by card BIN(s).

Issuer

API (Org’s resources)

Optional

Filter by issuing bank(s)

Method

API (Org’s resources)

Optional

Filter by transaction method(s).

Tx Type

API (Org’s resources)

Optional

Filter by transaction type(s). (Dependent on the Method filter)

PSP Service

API (Org’s resources)

Optional

Filter by specific PSP service(s).

⚙️ Rule Metric Conditions

image-20260304-090449.png

Time Window

Definition:

The time range used to retrieve transactions for metric calculations.
If the time window is defined as 60, it means retrieving all transactions created within the last 60 minutes from the current time.

Example:

If the current time is 2025-10-01 12:00:00 and Time Window = 60, → transactions from 2025-10-01 11:00:00 → 2025-10-01 12:00:00 will be included.

Example Dataset (Time Window = 60 minutes)

transactionID

customerEmail

created (UTC)

Included?

TX001

smith@gmail.com

2025-10-01 11:05:00

âś… Yes

TX002

emma.johnson@mail.com

2025-10-01 11:45:30

âś… Yes

TX003

liam.brown@yahoo.com

2025-10-01 10:58:10

❌ No (older than 60 mins)

TX004

ava.taylor@hotmail.com

2025-10-01 12:00:00

âś… Yes

Note:

Only transactions created between 2025-10-01 11:00:00 and 2025-10-01 12:00:00 are included in metric calculations because the Time Window is set to 60 minutes.

This ensures only recent transactions (e.g., the last 60 minutes) are counted in your metric, not older ones.

Acceptance Rate

Reference: AR

Type: number (float)

Sample: 60.5

Formula: (Successful Transactions / Total Transactions) Ă— 100

Description: Percentage of successful transactions out of total transactions within the selected time window.
Indicates the overall success rate of transaction processing for a merchant or system.

Notes:

  • Only transactions with state = SUCCESSFUL are counted.

  • Commonly used to evaluate payment performance or success trends over time.

Error Rate

Reference: ER

Type: number (float)

Sample: 60.5

Formula: (Failed Transactions / Total Transactions) Ă— 100

Description: Percentage of failed transactions out of total transactions within the selected time window. Helps identify the proportion of transactions that ended with an error or were rejected by the PSP.

Notes:

  • Only transactions with state = FAILED are counted.

  • Useful for monitoring system reliability and identifying processing issues.

Unique User

Reference: UNIQ_USER

Type: integer

Sample: 3

Formula: Count(Distinct customerEmail)

Description: Number of unique users identified by distinct customer email addresses (e.g., customerEmail or merchantUserEmail).

Notes:

  • A single customer performing multiple transactions is counted only once.

  • Measures reach or distinct customer count.

Transaction State Rate

Reference: TX_STATES

Type: number (float)

Sample: 80.0

Formula: (Transactions in Selected State / Total Transactions) Ă— 100

Description: Percentage of transactions belonging to a specific state (e.g., SUCCESSFUL, FAILED, PENDING, etc.).
Helps visualize transaction state distribution and monitor real-time processing status.

Notes:

  • Selected state is dynamically configurable based on rule or condition.

Transaction State Code

Type: string

Sample: Successful

Notes: Enumerated transaction states representing specific processing outcomes.

Possible Values:
Successful, Failed, Cancelled, Pending, Processing

BIN

Reference: BIN

Type: string

Sample: 537049, 535583

Description: Bank Identification Number (BIN) of the payment method used (e.g., for card transactions).

Issuer

Reference: ISSUER

Type: string

Sample: TERRA BANK

Description: Name of the issuing bank or financial institution that issued the card or payment method.

Error Code

Reference: ERROR_CODE

Type: string

Sample: 1001, 2003

Description: Represents the error response code returned by the Payment Service Provider (PSP) or internal system when a transaction fails.

Transaction Amount (For Single Transaction Only)

Reference: TX_AMOUNT

Type: number (float)

Sample: 400 EUR

Description: Transaction amount of the individual transaction being evaluated.

Notes:

  • Default currency is EUR.

  • Multi-currency support may be added later.

  • Supports all comparison operators (>, <, ≥, ≤, =).

Transaction Method (For Single Transaction Only)

Reference: TX_METHODS

Type: array (string[])

Sample: [DEPOSIT, WITHDRAWAL]

Description: Transaction method associated with the transaction.

Notes:

  • Represents the type of financial operation.

  • Supports operators ANYOF / ALLOF.

Merchant User (For Single Transaction Only)

Reference: MERCHANT_USER_ID

Type: array (string[])

Sample: [USER_ID_1, USER_ID_2]

Description: Identifier of the user within the merchant system associated with the transaction.

Notes:

  • Often used for monitoring specific users (e.g., VIP users or flagged accounts).

  • Supports operators ANYOF / ALLOF.

Deposit Amount (For Single Transaction Only)

Reference: TOTAL_DEPOSIT_AMOUNT

Type: number (float)

Sample: 3000

Description: Total deposit amount associated with the user when the transaction is evaluated.

Notes:

  • Used to monitor cumulative deposit thresholds.

  • Supports all comparison operators.

Account Holder Name (For Single Transaction Only)

Reference: ACCOUNT_HOLDER_NAME

Type: boolean

Sample: Yes

Description: Indicates whether the transaction account holder name matches the registered account user name.

Notes:

  • Used to detect potential mismatches between payment account holder and platform user.

  • Supports MATCH operators (MATCH ANY / MATCH ALL).

Net Loss (For Single Transaction Only)

Reference: NET_LOSS

Type: number (float)

Sample: 3000

Description:
Net loss value calculated for a user based on the difference between deposits and withdrawals.

Notes:

  • Calculated when deposits > withdrawals.

  • Used to monitor users losing significant amounts.

Net Win (For Single Transaction Only)

Reference: NET_WIN

Type: number (float)

Sample: 3000

Description: Net win value calculated for a user based on the difference between withdrawals and deposits.

Notes:

  • Calculated when withdrawals > deposits.

  • Used to monitor users winning significant amounts.

Consecutive Transaction (For Sequence Transaction Only)

Reference: CONSECUTIVE_FAILED_TX

Type: number (integer)

Sample: 15

Description: The number of consecutive failed transactions used for metric calculation.

For example, if Consecutive = 5, it means the system will retrieve each group of 5 consecutive failed transactions that occur within the defined Time Window for metric calculation.

Average Failed User Transactions Amount (For Sequence Transaction Only)

Reference: AVG_USER_TX_FAILED_AMOUNT

Type: number (integer)

Sample: 20

Description: The average transaction failed amount for a user

⚙️ Message Variables Reference

You can insert these variables into the message when you set up an action (Slack, Email, System, Jira, and Telegram). When the rule runs, each variable is replaced by the real value (e.g. merchant name, acceptance rate).

Filter variables

These are about what you selected in the Filter step of your rule (e.g. which merchant, country, or PSP the rule applies to).

image-20260304-073627.png

When you see them: You always see these options when you are writing a message. You don’t need to do anything special.

Note: If no conditions are selected in the Filter step but you still use filter-related variables in the message, those variables will not be populated with values.

Variable

What it gives you

{{filter_MERCHANT_ID}}

The merchant ID(s) you selected

{{filter_MERCHANT_NAME}}

The merchant name(s) you selected

{{filter_COUNTRY}}

The country(s) you selected

{{filter_PSP_SERVICE}}

The PSP service(s) you selected

{{filter_TX_TYPE}}

The transaction type(s) you selected

{{filter_BIN}}

The BIN(s) you selected

{{filter_ISSUER}}

The issuer(s) you selected

{{filter_PSP}}

The PSP(s) you selected

{{interval}}

The time interval for the rule (e.g. 5 minutes, 1 hour, 1 day)

Variables

Actual variables

These are about the conditions you set (e.g. “Acceptance Rate below 90%”). They show the actual value that was checked when the rule ran.

image-20260304-073654.png

When you see them: A variable only appears after you add a condition that uses that metric. For example, if you add a condition on “Acceptance Rate”, you will see {{AR}}. If you add a condition on “Error Code”, you will see {{ERROR_CODE}}.

Variable

Type

Description

{{AR}}

float

The Acceptance Rate value that was evaluated

{{ER}}

float

The Error Rate value that was evaluated

{{ERROR_CODE}}

string

The error code(s) from your condition

{{BIN}}

string

The BIN(s) from your condition

{{ISSUER}}

string

The issuer(s) from your condition

{{UNIQ_USER}}

number

The Unique Users value that was evaluated

{{RAR}}

float

The Acceptance Rate (Relative) value that was evaluated

{{RER}}

float

The Error Rate (Relative) value that was evaluated

Single Transaction Only

Variable

Type

Description

{{TX_AMOUNT}}

float

Amount of the evaluated transaction.

{{TX_METHODS}}

string[]

Method used in the evaluated transaction (e.g. DEPOSIT, WITHDRAWAL).

{{TOTAL_DEPOSIT_AMOUNT}}

float

Total deposit amount associated with the user.

{{ACCOUNT_HOLDER_NAME_VALUE}}

string

Account holder name evaluated in the transaction.

{{NET_WIN}}

float

Net win value calculated for the user.

{{NET_LOSS}}

float

Net loss value calculated for the user.

{{MERCHANT_USER_ID}}

string[]

Merchant user ID associated with the transaction.

Sequence Transaction Only

Variable

Type

Description

{{CONSECUTIVE_FAILED_TX}}

number

The number of consecutive failed transactions used for metric calculation.

{{AVG_USER_TX_FAILED_AMOUNT}}

number

The average transaction failed amount for a user

Transaction variables

These give you information about the specific transaction(s) that triggered the rule (e.g. which merchants, PSPs, countries, or users were involved).

When you see them: You only see these when your rule is set to run on Single Transaction or Sequential Transaction in the Filter step. If your rule runs on a time interval (e.g. “every 5 minutes” or “every 1 hour”), these variables are not available.

Variable

What it gives you

{{transaction_merchants}}

The merchant(s) linked to the transaction(s) that triggered the rule

{{transaction_psps}}

The PSP(s) linked to those transaction(s)

{{transaction_countries}}

The country/countries linked to those transaction(s)

{{transaction_ids}}

The transaction ID(s)

{{transaction_users}}

The user(s) linked to those transaction(s)

{{transaction_psp_accounts}}

The transaction PSP Account(s)

{{transaction_merchant_ids}}

The merchant ID(s) linked to the transaction(s) that triggered the rule

In short: Use these when your rule type is Single Transaction or Sequential Transaction. They do not appear for Interval (time-based) rules.

Condition Variables

These variables represent the values defined in rule conditions (thresholds or comparison lists).
They are automatically generated when you configure a condition in the rule.

image-20260304-073740.png

When you see them: A variable appears only after the corresponding condition is added in the rule configuration.

Variable

Type

Description

{{condition_AR_THRESHOLD_[number]}}

float

Threshold value defined for Acceptance Rate (AR).

{{condition_ERROR_THRESHOLD_[number]}}

float

Threshold value defined for Error Rate (ER).

{{condition_UNIQ_USER_THRESHOLD_[number]}}

integer

Threshold value defined for Unique Users (UNIQ_USER).

{{condition_TX_STATE_RATE_THRESHOLD_[number]}}

float

Threshold value defined for Transaction State Rate (TX_STATES).

{{condition_TX_STATE_[number]}}

string[]

Transaction state codes used in the rule condition (e.g. SUCCESSFUL, FAILED).

{{condition_BINS_[number]}}

string[]

BIN values used in the condition.

{{condition_ISSUERS_[number]}}

string[]

Issuer names used in the condition.

{{condition_ERROR_CODES_[number]}}

string[]

Error codes defined in the rule condition.

Single Transaction Only

Variable

Type

Description

{{TX_AMOUNT_THRESHOLD}}

float

Threshold value used to compare the transaction amount (e.g. TX_AMOUNT ≥ threshold).

{{TX_METHOD}}

string[]

Transaction method values used in the condition.

{{TOTAL_DEPOSIT_AMOUNT_THRESHOLD}}

float

Threshold value used to evaluate the user's total deposit amount.

{{ACCOUNT_HOLDER_NAME_VALUE}}

string

Account holder name value used for matching with the registered user name.

{{NET_WIN_THRESHOLD}}

float

Threshold value used to evaluate the user's net win amount.

{{NET_LOSS_THRESHOLD}}

float

Threshold value used to evaluate the user's net loss amount.

{{MERCHANT_USER_ID_VALUE}}

string[]

Merchant user ID values used in the condition to match specific users.

For Sequence Transaction Only

Variable

Type

Description

{{CONSECUTIVE_FAILED_TX_THRESHOLD}}

number

Threshold value defining the number of consecutive failed transactions required to trigger the rule.

{{AVG_USER_TX_FAILED_AMOUNT_THRESHOLD}}

number

Threshold value for the average failed transaction amount per user used in the rule condition.

Notes

  • [number] represents the order of the condition in the rule (e.g. condition_AR_THRESHOLD_1, condition_AR_THRESHOLD_2).

  • These variables allow the message to display the configured rule condition values, not the calculated metric values.

  • They are typically used in alert messages to show what threshold or filter triggered the rule.