Skip to main content

ExtraData

Matches transactions by an arbitrary key/value pair in the transaction's extraData field. Shown as "Extra data" in the condition catalogue.

Parameters

FieldTypeRequiredAllowed values
keystringyesThe name of the extraData field to inspect, e.g. "channel", "sku"
comparatorstringyes"=", "!=", "matches", "matches_not"
valuestringyesThe literal value (for = / !=) or PCRE regular expression (for matches / matches_not) to compare against

Example — exact match

{
"constraint": "ExtraData",
"params": {
"key": "channel",
"comparator": "=",
"value": "premium"
}
}

Example — regex match

{
"constraint": "ExtraData",
"params": {
"key": "sku",
"comparator": "matches",
"value": "^PREMIUM-"
}
}

Notes

  • Availability: might not be included in your platform package — if this condition is missing from the catalogue returned by List routing constraints, contact your Customer Success Manager to have it activated.
  • The matches / matches_not comparators take a PCRE-style regular expression without delimiters.
  • If the transaction has no extraData field with the configured key, the rule treats the value as absent — the result depends on the comparator (= returns false; != returns true; regex comparators return false / true accordingly). Exception: the key currency falls back to the transaction's currency when it is not present in extraData.
  • Also available in multi-method routing documents.