Rule conditions

Conditions are the if part of routing rules: each if node of a routing document names a condition in its constraint field and passes condition-specific parameters. This catalogue lists every condition, grouped by what it inspects; the linked pages document each condition's parameters and examples.

Use List routing constraints to discover at runtime which conditions are available to your tenant, together with a JSON Schema for each condition's parameters.

Card

Identifier	Purpose
CreditcardType	Match the card brand (Visa, Mastercard, …)
CreditcardCardNetwork	Match the card network (coarser than brand)
CreditCardTokenType	Match the token type (Apple Pay, Google Pay, Click-to-Pay, raw card)
CreditcardBinCountry	Match the card issuer country (from the BIN)
CreditcardBinLevel	Match the card level (Platinum, Corporate, …)
CreditcardBinType	Match credit vs. debit cards
CreditcardBinSegment	Match the card segment (Consumer, Commercial, …)
CreditcardBinPrepaid	Match prepaid vs. non-prepaid cards
CreditcardBinReloadable	Match reloadable vs. non-reloadable cards
CreditcardBinLookupStatus	Match by the outcome of the BIN lookup
BinRangeRegexp	Match the BIN against a regular expression
HasReferenceSchemeTransactionId	Match the presence of a scheme transaction ID

Customer

Identifier	Purpose
CustomerCountry	Match the customer's billing country
CustomerIpCountry	Match the customer's country resolved from the IP address

Transaction

Identifier	Purpose
Currency	Match the transaction currency
AmountCurrency	Compare the transaction amount in a chosen currency to a threshold
TransactionType	Match the transaction type (debit, preauthorize, …)
IsRecurring	Match recurring vs. one-off transactions
ExtraData	Match a key/value pair of the transaction's extra data
InitialConnector	Match the connector that processed the initial transaction
InitialAdapter	Match the adapter and method that processed the initial transaction
RandomLoadBalancer	Split traffic probabilistically for load balancing

Bank account

Identifier	Purpose
IbanRegexp	Match the customer IBAN against a regular expression
IbanRoutingRule	Match a value at a fixed position within the customer IBAN

Risk

Identifier	Purpose
RiskScore	Compare the risk score of the transaction to a threshold
ChargebackCountOrVolumePerConnector	Compare the chargeback count or volume over a time window
DebitPreauthCountOrVolumePerConnector	Compare the debit/preauthorize count or volume over a time window

Availability

Not every condition is available in every setup:

• Platform package — not every condition is included out of the box; the catalogue returned by List routing constraints is authoritative for your setup.
• Multi-method routing accepts at most a fixed subset of the catalogue: CustomerCountry, CustomerIpCountry, Currency, AmountCurrency, RiskScore and ExtraData; the conditions available to your setup apply on top. All other conditions are available for routing meta-connectors only.

Using a condition outside its availability returns error code 1011.

IXOPAY platform Full Version

Additional routing rule conditions are an optional feature which is not automatically available for all IXOPAY platform clients!

If you want to get access to all IXOPAY platform features you need to upgrade your plan. Please contact your Customer Success Manager or our sales team at [email protected] for more information.

Evaluation semantics

• A condition that cannot be evaluated for a given transaction — for example, a card condition on a transaction without card data — stops rule evaluation entirely, and the transaction is routed to the default connector. The else branch is followed only when a condition evaluates to false. Some conditions instead evaluate to false (or, for notin comparators, to true) when the inspected data is missing — the individual condition pages document these cases.
• Condition identifiers and parameter values are case-sensitive exactly as documented on each page.
• The parameter schemas returned by List routing constraints are the authoritative, tenant-aware description of each condition's parameters.