Skip to navigation
ReferenceFeaturesProvisioningConnector routingRule conditions

CustomerIpCountry

Matches transactions whose customer IP-resolved country (via GeoIP) is (or is not) in a configured list. Shown as “Customer IP Country” in the condition catalogue.

Parameters

FieldTypeRequiredAllowed values
countriesarray of stringsyesOne or more ISO 3166-1 alpha-2 country codes, e.g. ["US", "CA"]
comparatorstringyes"in" or "notin"

Example

{
  "constraint": "CustomerIpCountry",
  "params": {
    "countries": ["US", "CA"],
    "comparator": "notin"
  }
}

Notes

  • Country comparison is case-insensitive, but ISO 3166-1 alpha-2 uppercase form is the recommended canonical input.
  • The Provisioning API requires the modern multi-country shape shown above. The legacy single-country shape ({"country": "US"}) is no longer accepted via this endpoint — and a payload that mixes both country and countries is rejected outright.
  • If the transaction has no customer attached, the rule is skipped and routing falls through to the default connector.
  • Included in every platform package.
  • Also available in multi-method routing documents.