Validierungs- und Prüfservices - WEBSALE Dokumentation

Diese Seite beschreibt die verfügbaren Services zur Validierung von Benutzereingaben sowie die regelbasierten Prüfungen für Zahlungs- und Versandarten. Dazu kommen fest implementierte Services, die eine Zahlungsart an einen Zahlungsanbieter anbinden, Captchas prüfen oder Werte zwischen Einheiten umrechnen. Die Services sind keine klassischen Konfigurationsknoten mit eigener Struktur, sondern werden in den jeweiligen Formular- oder Regeldefinitionen referenziert, beispielsweise in Account-, Checkout- oder Payment-/Shipping-Konfigurationen. Der Verweis besteht aus dem Service-Namen im Format <Servicetyp>.<Implementierung> und bei Bedarf aus einem Objekt options:

{
  "service": "addressCheck.minLength",
  "options": {
    "len": 1
  }
}

Prüfservices stehen meist in einer Liste validations, die mehrere Einträge enthalten kann. Die übrigen Services werden über ein einzelnes Feld vom Typ singleService referenziert.

Servicetyp	Einsatzort	Aufgabe
`addressCheck.*`	`accounts.addressField` → `validations`	Prüft Eingaben in Adressfeldern.
`dataChecker.*`	`validations` der Formular- und Kundendatenfelder, beispielsweise `inquiry.form` oder `customer.customerDataField`	Prüft Eingaben in allgemeinen Formularfeldern.
`paymentValidation.*`	`payment.payment` → `validations`	Entscheidet, ob eine Zahlungsart erlaubt ist.
`paymentFieldDisplayCheck.*`	`payment.paymentField` → `displayConditions`	Entscheidet, ob ein Zusatzfeld einer Zahlungsart im Checkout angezeigt wird.
`shippingMethodValidation.*`	Versandart → `validations`	Entscheidet, ob eine Versandart erlaubt ist.
`payment.*`	`payment.payment` → `onlineClearing`	Verknüpft eine Zahlungsart mit einem Online-Clearing-Anbieter.
`captchaCheck.*`	`inquiry.form` → `captcha` `payment.paymentBlock` → `captcha` `security.actionGuard` → `captcha`	Prüft das Captcha-Token, das das Frontend mitschickt.
`unitConverter.*`	`customer.customerDataField` → `type.number.unit.dynamic.converter`	Rechnet den Wert eines Kundendatenfelds beim Wechsel der Einheit um.

`addressCheck.*` - Adressvalidierungen

addressCheck.* enthält Prüfungen für Adressfelder (z.B. Name, Straße, PLZ). Die Prüfungen werden in den jeweiligen Felddefinitionen unter validations hinterlegt. Das Frontend zeigt die Felder wie konfiguriert an und prüft beim Ausfüllen, ob die Eingaben gültig sind. So werden falsche oder unzulässige Werte früh erkannt.

`addressCheck.minLength` - Mindestlänge

Prüft die Mindestlänge der Eingabe bei Adressfeldern.

Beispielkonfiguration für (`accounts.addressField.firstName`)

{
  "label": "",
  "name": "firstName",
  "validations": [
    {
      "options": {
        "len": 1
      },
      "service": "addressCheck.minLength"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`len`	Gewünschte Mindestlänge in Zahlen.

`addressCheck.maxLength` - Maximallänge

Prüft die Maximallänge der Eingabe bei Adressfeldern.

Beispielkonfiguration für (`accounts.addressField.firstName`)

{
  "label": "",
  "name": "firstName",
  "validations": [
    {
      "options": {
        "len": 255
      },
      "service": "addressCheck.maxLength"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`len`	Gewünschte Maximallänge in Zahlen.

`addressCheck.numeric` - Nur Ziffern

Prüft, ob die Eingabe bei Adressfeldern nur aus Ziffern besteht.

Beispielkonfiguration für (`accounts.addressField.phone`)

{
  "label": "",
  "name": "phone",
  "validations": [
    {
      "service": "addressCheck.numeric"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.country` - Ländercode (ISO)

Prüft, ob die Eingabe resp. Auswahl bei Länderlisten der Adressdatenfelder ein im Shop konfigurierter Ländercode ist (ISO-Code: 2-stellig, 3-stellig oder ISO-Nummer). Die offiziellen ISO-3166-1-Codes (alpha-2, alpha-3 und numerisch) finden sich auf der Website der International Organization for Standardization (ISO): https://www.iso.org/iso-3166-country-codes.html

Beispielkonfiguration für (`accounts.addressField.country`)

{
  "label": "",
  "name": "country",
  "validations": [
    {
      "service": "addressCheck.country"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.zip` - Postleitzahl (PLZ)

Prüft, ob die Eingabe eine gültige Postleitzahl (PLZ) für das angegebene Land ist. Die PLZ-Regeln stammen aus der Konfiguration. Das dazugehörige Land muss zwingend im Feld country übergeben werden.

Beispielkonfiguration für (`accounts.addressField.zip`)

{
  "label": "",
  "name": "zip",
  "validations": [
    {
      "service": "addressCheck.zip"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.salutation` - Anrede (Code)

Prüft, ob die Eingabe eine gültige Anrede ist (Code gemäß Konfiguration).

Beispielkonfiguration für (`accounts.addressField.salutationCode`)

{
  "label": "",
  "name": "salutationCode",
  "validations": [
    {
      "service": "addressCheck.salutation"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.regex` - Regulärer Ausdruck

Prüft, ob die Eingabe zu einem regulären Ausdruck passt.

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    {
      "options": {
        "expression": "^((?i)(?!Postfach).)*$"
      },
      "service": "addressCheck.regex"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`expression`	Regulärer Ausdruck (Zeichenkette).

`addressCheck.phone` - Telefonnummer

Prüft, ob die Eingabe eine gültige Telefonnummer ist. Eine gültige Nummer besteht aus Ziffern (ohne Längenbeschränkung) und optional einer internationalen Vorwahl. Das + in der Vorwahl wird nach erfolgreicher Validierung durch 00 ersetzt.

Beispielkonfiguration für (`accounts.addressField.phone`)

{
  "label": "",
  "name": "phone",
  "validations": [
    {
      "service": "addressCheck.phone"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.alpha` - Nur Buchstaben (A–Z)

Prüft, ob die Eingabe nur aus lateinischen Buchstaben besteht (Groß-/Kleinschreibung egal).

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { "service": "addressCheck.alpha" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.alphanum` - Buchstaben/Ziffern (A–Z/0–9)

Prüft, ob die Eingabe nur aus lateinischen Buchstaben oder Ziffern besteht (Groß-/Kleinschreibung egal).

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    { "service": "addressCheck.alphanum" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`addressCheck.legalSigns` - Erlaubte Zeichen

Prüft, ob alle Zeichen der Eingabe in der erlaubten Zeichenauswahl enthalten sind (Groß-/Kleinschreibung relevant).

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    {
      "options": {
        "signs": "123456ABCSDEF"
      },
      "service": "addressCheck.legalSigns"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`signs`	Erlaubte Zeichen (Zeichenkette).

`addressCheck.illegalSigns` - Verbotene Zeichen

Gegenteil von legalSigns: Die Eingabe darf keines der angegebenen Zeichen enthalten.

Beispielkonfiguration für (`accounts.addressField.phone`)

{
  "label": "",
  "name": "phone",
  "validations": [
    {
      "options": {
        "signs": "*|~%${};\"<>§@()/-_#"
      },
      "service": "addressCheck.illegalSigns"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`signs`	Unerlaubte Zeichen (Zeichenkette).

`addressCheck.date` - Datum

Prüft, ob die Eingabe ein gültiges Datum ist, und formatiert die Eingabe bei Bedarf.

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

{
  "label": "",
  "name": "additionalInfo",
  "validations": [
    {
      "options": {
        "delimiter": "-",
        "dateformat": "DMY",
        "formatleadingzero": false
      },
      "service": "addressCheck.date"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`delimiter`	Trennzeichen zwischen Tag/Monat/Jahr (z. B. `-` für `15-10-2025`).
`dateformat`	Beliebige Kombination aus `D`, `M`, `Y` (z. B. `DMY` für `15-10-2025`).
`formatleadingzero`	Wenn aktiv (`true`), werden Tage/Monate zweistellig formatiert (`5 → 05`). Wenn deaktiviert (`false`), werden führende Nullen entfernt (`05 → 5`). (Wahrheitswert)

`addressCheck.allowedSelection` - Auswahl (Listenelement)

Validiert, ob die Eingabe einem vordefinierten Auswahlwert entspricht. Die zulässigen Werte stammen aus einer Adressliste unter general.addressListElements, die über listElements referenziert wird. Typische Anwendung: Prüfung, ob eine Adresse z. B. „Packstation” oder „Privatadresse” ist.

Beispielkonfiguration für (`accounts.addressField.addressType`)

{
  "label": "",
  "name": "addressType",
  "validations": [
    {
      "options": {
        "listElements": "billAddressType"
      },
      "service": "addressCheck.allowedSelection"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`listElements`	Referenz auf die Adressliste, deren Werte zulässig sind. Zulässig ist die `dataId` der Liste (z. B. `billAddressType`) oder der vollständige Knotenpfad (z. B. `general.addressListElements.billAddressType`). Beide Schreibweisen sind gleichwertig.

Zusammenspiel mit dem addressType der Liste Ob die Prüfung überhaupt greift, hängt vom Parameter addressType der referenzierten Liste ab:

`addressType` der Liste	Prüfung bei Rechnungsadresse	Prüfung bei Lieferadresse	Prüfung ohne Adresstyp-Kontext
`"bill"`	greift	greift nicht	greift nicht
`"delivery"`	greift nicht	greift	greift nicht
`"both"`	greift	greift	greift
nicht gesetzt	greift	greift	greift nicht

Greift die Prüfung nicht, wird das Feld ohne Fehler akzeptiert, die Validierung fällt also stillschweigend aus, statt die Eingabe abzulehnen. Dasselbe gilt, wenn unter listElements eine ID referenziert wird, zu der keine Adressliste existiert (z. B. nach einem Tippfehler oder nach dem Löschen der Liste).Prüfen Sie deshalb bei einem Feld, das unerwartet beliebige Werte annimmt, zuerst die Schreibweise der Referenz und den addressType der Liste.

Weiterführend

general.addressListElements – Definition der Listen und ihrer zulässigen Werte.
$wsConfig.listElements – Ausgabe derselben Liste als Auswahlfeld im Formular.

`dataChecker.*` - Allgemeine Feldvalidierungen

dataChecker.* enthält Prüfungen für allgemeine Formularfelder, die nicht speziell zu einer Adresse gehören. Die Prüfungen werden in der jeweiligen Felddefinition unter validations eingebunden. Das Frontend übernimmt die Vorgaben aus der Felddefinition und prüft beim Ausfüllen, ob die Eingabe korrekt ist (beispielsweise Länge, Format oder unerlaubte Zeichen). Schlägt eine Prüfung fehl, gibt der Shop einen Fehlertext aus, der zur jeweiligen Prüfung passt, beispielsweise “Die Eingabe ist zu kurz.” bei dataChecker.minLength. Die Texte stehen für alle dataChecker.*-Services gemeinsam im Knoten general.dataCheckerValidationErrors. Bei den Zusatzfeldern von Zahlungsarten und beim Online-Bestellschein nennt subCode im Fehlerobjekt zusätzlich den fehlgeschlagenen Service, beispielsweise dataChecker.minLength.

`dataChecker.minLength` - Mindestlänge

Prüft die Mindestlänge der Eingaben bei Formular-Eingabefeldern.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.firstName`)

{
  "label": "Vorname",
  "name": "firstName",
  "required": true,
  "validations": [
    { "options": { "len": 3 }, "service": "dataChecker.minLength" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`len`	Gewünschte Mindestlänge in Zahlen.

`dataChecker.maxLength` - Maximallänge

Prüft die Maximallänge der Eingaben bei Formular-Eingabefeldern.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.firstName`)

{
  "label": "Vorname",
  "name": "firstName",
  "required": true,
  "validations": [
    { "options": { "len": 255 }, "service": "dataChecker.maxLength" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`len`	Gewünschte Maximallänge in Zahlen.

`dataChecker.numericChecker` - Nur Ziffern

Prüft, ob die Eingabe bei Formular-Eingabefeldern nur aus Ziffern besteht.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.phone`)

{
  "label": "Telefon",
  "name": "phone",
  "validations": [
    { "service": "dataChecker.numericChecker" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`dataChecker.countryChecker` - Ländercode (ISO)

Prüft, ob die Eingabe resp. Auswahl bei Länderlisten der Formularfelder ein im Shop konfigurierter Ländercode ist (ISO-Code: 2-stellig, 3-stellig oder ISO-Nummer). Die offiziellen ISO-3166-1-Codes (alpha-2, alpha-3 und numerisch) finden sich auf der Website der International Organization for Standardization (ISO): https://www.iso.org/iso-3166-country-codes.html

Beispielkonfiguration für (`inquiry.form.catalogue.fields.country`)

{
  "label": "Land",
  "name": "country",
  "validations": [
    { "service": "dataChecker.countryChecker" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`dataChecker.zipCodeChecker` - Postleitzahl (PLZ)

Beispielkonfiguration für (`inquiry.form.catalogue.fields.zip`)

{
  "label": "Postleitzahl",
  "name": "zip",
  "validations": [
    { "service": "dataChecker.zipCodeChecker" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter. (Für länderspezifische Prüfung muss das Feld `country` im Kontext verfügbar sein.)

`dataChecker.salutation` - Anrede (Code)

Prüft, ob die Eingabe eine gültige Anrede ist (Code gemäß Konfiguration).

Beispielkonfiguration für (`inquiry.form.catalogue.fields.salutation`)

{
  "label": "Anrede",
  "name": "salutation",
  "validations": [
    { "service": "dataChecker.salutation" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`dataChecker.regex` - Regulärer Ausdruck

Prüft, ob die Eingabe zu einem regulären Ausdruck passt.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "validations": [
    {
      "options": {
        "expression": "^((?i)(?!Postfach).)*$"
      },
      "service": "dataChecker.regex"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`expression`	Regulärer Ausdruck (Zeichenkette).

`dataChecker.email` - E‑Mail-Adresse

Prüft, ob die Eingabe eine gültige E‑Mail-Adresse ist.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.mail`)

{
  "label": "E-Mail-Adresse",
  "name": "mail",
  "validations": [
    { "service": "dataChecker.email" }
  ]
}

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`dataChecker.alphaClass` - Buchstaben (min/verschiedene)

Stellt sicher, dass die Eingabe mindestens minChars lateinische Buchstaben enthält (Groß-/Kleinschreibung egal); optional Mindestanzahl unterschiedlicher Buchstaben.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "minChars": 8,
        "minDifferentChars": 2
      },
      "service": "dataChecker.alphaClass"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`minChars`	Mindestanzahl an Buchstaben (Zahl ≥ 0).
`minDifferentChars`	Mindestanzahl unterschiedlicher Buchstaben (Zahl ≥ 0).

`dataChecker.lowerAlphaClass` - Kleinbuchstaben

Wie alphaClass, jedoch nur Kleinbuchstaben.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "minChars": 8,
        "minDifferentChars": 2
      },
      "service": "dataChecker.lowerAlphaClass"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`minChars`	Mindestanzahl an Kleinbuchstaben (Zahl ≥ 0).
`minDifferentChars`	Mindestanzahl unterschiedlicher Kleinbuchstaben (Zahl ≥ 0).

`dataChecker.upperAlphaClass` - Großbuchstaben

Wie alphaClass, jedoch nur Großbuchstaben.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "minChars": 8,
        "minDifferentChars": 2
      },
      "service": "dataChecker.upperAlphaClass"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`minChars`	Mindestanzahl an Großbuchstaben (Zahl ≥ 0).
`minDifferentChars`	Mindestanzahl unterschiedlicher Großbuchstaben (Zahl ≥ 0).

`dataChecker.digitClass` - Ziffern

Wie alphaClass, jedoch für Ziffern.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "minChars": 4,
        "minDifferentChars": 2
      },
      "service": "dataChecker.digitClass"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`minChars`	Mindestanzahl an Ziffern (Zahl ≥ 0).
`minDifferentChars`	Mindestanzahl unterschiedlicher Ziffern (Zahl ≥ 0).

`dataChecker.specialClass` - Sonderzeichen

Wie alphaClass, jedoch für Sonderzeichen.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "minChars": 2,
        "minDifferentChars": 1
      },
      "service": "dataChecker.specialClass"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`minChars`	Mindestanzahl an Sonderzeichen (Zahl ≥ 0).
`minDifferentChars`	Mindestanzahl unterschiedlicher Sonderzeichen (Zahl ≥ 0).

`dataChecker.sequenceOfIdenticalCharacters` - Wiederholte Zeichen (Sequenz)

Prüft, ob dasselbe Zeichen zu oft hintereinander vorkommt.

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "caseInsensitive": false,
        "maxSequence": 2
      },
      "service": "dataChecker.sequenceOfIdenticalCharacters"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`caseInsensitive`	Groß-/Kleinschreibung ignorieren (Wahrheitswert).
`maxSequence`	Maximale erlaubte Wiederholung eines Zeichens (Zahl ≥ 0).

`dataChecker.consecutiveNumbers` - Fortlaufende Zahlen

Prüft auf auf- oder absteigende Zahlenketten (z. B. 12345 oder 54321).

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "maxConsecutive": 2
      },
      "service": "dataChecker.consecutiveNumbers"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`maxConsecutive`	Maximale Länge der Zahlenkette (Zahl ≥ 0).

`dataChecker.consecutiveLetters` - Fortlaufende Buchstaben

Prüft auf auf- oder absteigende Buchstabenkombinationen (z. B. abcd oder dcba).

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "maxConsecutive": 2,
        "caseInsensitive": false
      },
      "service": "dataChecker.consecutiveLetters"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`maxConsecutive`	Maximale Länge der Buchstabenkette (Zahl ≥ 0).
`caseInsensitive`	Groß-/Kleinschreibung ignorieren (Wahrheitswert).

`dataChecker.palindrome` - Palindrom

Prüft, ob die Eingabe ein Palindrom ist (vorwärts/rückwärts identisch, z. B. „Otto”).

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

{
  "label": "Zusatzinformation",
  "name": "additionalInfo",
  "required": true,
  "validations": [
    {
      "options": {
        "caseInsensitive": false
      },
      "service": "dataChecker.palindrome"
    }
  ]
}

Parameterübersicht

Parameter	Beschreibung
`caseInsensitive`	Groß-/Kleinschreibung ignorieren (Wahrheitswert).

`paymentValidation.*` - Zahlungsarten-Validierung

paymentValidation.* enthält Regeln, mit denen festgelegt wird, ob eine Zahlungsart im Checkout erlaubt ist. Die Prüfung kann z.B. vom Land der Rechnungs- oder Lieferadresse, vom Kundentyp, vom Warenkorb oder vom Bestellwert abhängen. Diese Regeln können in der Konfiguration der jeweiligen Zahlungsart unter validations eingetragen werden. Das Frontend zeigt dann nur passende Zahlungsarten an oder verhindert die Auswahl, wenn die Bedingungen nicht erfüllt sind. Hier geht es zum zugehörigen Konfigurationsknoten payment: payment - Zahlungsmethoden Auswertung im Frontend Im Template werden die konfigurierten Regeln über die Methode $wsCheckout.isValidPayment(paymentId) ausgewertet: Sie führt alle unter validations hinterlegten Services aus und gibt false zurück, sobald mindestens eine Regel fehlschlägt. So werden nicht verfügbare Zahlungsarten in der Auswahl deaktiviert oder ausgeblendet.

{{ foreach $cPayment in $wsConfig.payments }}
  <input type="radio" name="paymentId" value="{{= $cPayment.id }}"
    {{ if not $wsCheckout.isValidPayment($cPayment.id) }} disabled{{ /if }}>
  <label>{{= $cPayment.name }}</label>
{{ /foreach }}

Für die aktuell ausgewählte Zahlungsart stehen die Gründe einer fehlgeschlagenen Prüfung unter $wsCheckout.problems.payment bereit. Das Feld subCode nennt den fehlgeschlagenen Service.

`paymentValidation.billCountry` - Validierung des Landes (Rechnungsadresse) für Zahlungsarten

Prüft, ob das Land der Rechnungsadresse entsprechend einer „Allow/Deny”-Liste für eine Zahlungsart zulässig ist. Über die Optionen kann festgelegt werden, für welche Länder die Regel greift und ob diese Liste Länder erlaubt oder verbietet.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "countryList": [
        "general.country.de",
        "general.country.at",
        "general.country.ch"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.billCountry"
  }
]

Parameterübersicht

Parameter	Beschreibung
`countryList`	Liste der Länder, auf die diese Regel angewendet werden soll, als Knoten-IDs aus `general.country` (beispielsweise `general.country.de`). Das Land der Adresse wird über das zwei- oder dreistellige ISO-Kürzel oder den numerischen ISO-Code einem aktiven Länderknoten zugeordnet.
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Länder, die in `countryList` stehen, sind erlaubt. - `deny` - Länder, die in `countryList` stehen, sind nicht erlaubt.

`paymentValidation.billPhone` - Validierung der Telefonnummer

Prüft, ob für die Rechnungsadresse eine Telefonnummer angegeben ist (das Feld darf nicht leer sein).

Beispielkonfiguration

"validations": [
  {
    "service": "paymentValidation.billPhone"
  }
]

Für diesen Service sind keine Parameter vorhanden.

`paymentValidation.billDateOfBirth` - Validierung des Geburtsdatums

Prüft, ob für die Rechnungsadresse ein Geburtsdatum angegeben ist (das Feld darf nicht leer sein).

Beispielkonfiguration

"validations": [
  {
    "service": "paymentValidation.billDateOfBirth"
  }
]

Für diesen Service sind keine Parameter vorhanden.

`paymentValidation.shippingCountry` - Validierung des Landes (Lieferadresse)

Prüft, ob das Land der Lieferadresse entsprechend einer „Allow/Deny”-Liste zulässig ist. Über die Optionen kann festgelegt werden, für welche Länder die Regel greift und ob diese Liste Länder erlaubt oder verbietet.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "countryList": [
        "general.country.gb"
      ],
      "rule": "deny"
    },
    "service": "paymentValidation.shippingCountry"
  }
]

Parameterübersicht

Parameter	Beschreibung
`countryList`	Liste der Länder, auf die diese Regel angewendet werden soll, als Knoten-IDs aus `general.country` (beispielsweise `general.country.de`). Das Land der Adresse wird über das zwei- oder dreistellige ISO-Kürzel oder den numerischen ISO-Code einem aktiven Länderknoten zugeordnet.
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Länder, die in `countryList` stehen, sind erlaubt. - `deny` - Länder, die in `countryList` stehen, sind nicht erlaubt.

`paymentValidation.shippingMethod` - Validierung der Versandart für Zahlungsarten

Prüft, ob die gewählte Zahlart nur mit bestimmten Versandarten verwendet werden darf.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "shippingMethods": [
        "shipping.method.dhl",
        "shipping.method.pickup"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.shippingMethod"
  }
]

Parameterübersicht

Parameter	Beschreibung
`shippingMethods`	Liste der Versandarten-IDs, auf die diese Regel angewendet werden soll. Die IDs entsprechen den internen Namen der Versandarten (z.B. `shipping.method.dhl`).
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Versandarten, die in `shippingMethods` stehen, sind erlaubt. - `deny` - Versandarten, die in `shippingMethods` stehen, sind nicht erlaubt.

`paymentValidation.accountType` - Validierung des Kundentyps für Zahlungsarten

Prüft, ob die gewählte Zahlart nur für bestimmte Kundentypen verwendet werden darf (Gast, Neukunde oder Bestandskunde).

Beispielkonfiguration

"validations": [
  {
    "options": {
      "deny": [
        "guest",
        "newCustomer"
      ]
    },
    "service": "paymentValidation.accountType"
  }
]

Parameterübersicht

Parameter	Beschreibung
`deny`	Liste an Kundentypen, für die die Zahlart gesperrt ist. Mögliche Werte: - „`guest`” - Gastbesteller - „`newCustomer`” - Neukunde - „`customer`” - Bestandskunde

Wie der Kundentyp ermittelt wird

guest - Der Kunde bestellt als Gast (ohne Benutzerkonto).
newCustomer - Ein eingeloggter Kunde, der beim Login die in accounts.account.newCustomerRules konfigurierten Neukunden-Regeln erfüllt. Eine Neuregistrierung im Bestellablauf führt unabhängig von den Regeln immer zum Typ newCustomer.
customer - Jeder andere eingeloggte Kunde. Sind keine Neukunden-Regeln konfiguriert, gelten eingeloggte Kunden immer als customer.

Der hier geprüfte Kundentyp ist nicht identisch mit der Template-Variable $wsCheckout.accountType (guest / new / registered): Diese gibt die im Bestellablauf gewählte Anmeldemethode aus, während die Validierung zwischen Neu- und Bestandskunden (newCustomer / customer) unterscheidet. In den Bestelldaten werden customer und newCustomer beide als registered ausgegeben.

`paymentValidation.denyDifferingShippingAddress` - Validierung abweichender Lieferadressen für Zahlungsarten

Prüft, ob Rechnungsadresse und Lieferadresse identisch sind.
Die Zahlart ist nur erlaubt, wenn keine abweichende Lieferadresse verwendet wird.

Beispielkonfiguration

"validations": [
  {
    "service": "paymentValidation.denyDifferingShippingAddress"
  }
]

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`paymentValidation.voucherDeny` - Validierung von Gutscheinprodukten für Zahlungsarten

Prüft, ob Gutscheinprodukte im Warenkorb sind. Wenn Gutscheinprodukte im Warenkorb sind, ist diese Zahlart nicht erlaubt.

Beispielkonfiguration

"validations": [
  {
    "service": "paymentValidation.voucherDeny"
  }
]

Parameterübersicht

Parameter	Beschreibung
—	Keine zusätzlichen Parameter.

`paymentValidation.total` - Validierung von Mindest- / Maximalbestellwert für Zahlungsarten

Prüft, ob die Zahlart nur verwendet werden darf, wenn ein bestimmter Mindest- oder Maximalbestellwert erreicht bzw. überschritten wird.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "total": 600,
      "type": "max"
    },
    "service": "paymentValidation.total"
  }
]

Parameterübersicht

Parameter	Beschreibung
`total`	Grenzwert der Gesamtsumme (Warenwert), ab bzw. bis zu der die Zahlart erlaubt ist.
`type`	Art der Prüfung. Mögliche Werte: - „`min`” - Die Zahlart ist nur erlaubt, wenn der Bestellwert mindestens `total` erreicht. - „`max`” - Die Zahlart ist nur erlaubt, wenn der Bestellwert `total` nicht überschreitet.

Wenn Mindest- und Maximalbestellwert gleichzeitig geprüft werden sollen, muss diese Prüfung zweimal mit unterschiedlichen Optionen konfiguriert werden.

`paymentValidation.inventoryState` - Validierung des Lagerbestandes für Zahlungsarten

Prüft, ob sich im Warenkorb Produkte mit einem bestimmten Lagerbestand befinden. Wenn ein Produkt im Warenkorb einen in deny konfigurierten Status hat, ist die Zahlungsart nicht erlaubt.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "deny": [
        "red",
        "yellow"
      ]
    },
    "service": "paymentValidation.inventoryState"
  }
]

Parameterübersicht

Parameter	Beschreibung
`deny`	Liste an Lagerbestandsdaten, bei denen die Zahlungsart verboten ist. Mögliche Werte: - „`red`” - ausverkauft - „`yellow`” - nur noch wenige vorhanden - „`green`” - viele vorhanden Die Grenzwerte der einzelnen Lagerbestände werden in `content.inventory` festgelegt: content - Katalog (Kategorien & Produkte)

`paymentValidation.productDependency` - Validierung der Produkt-Abhängigkeiten für Zahlungsarten

Prüft die Produkte im Warenkorb anhand der Konfiguration checkout.productDependency.
Eine Zahlungsart wird nur angeboten, wenn alle referenzierten Produktabhängigkeiten erfüllt sind. Auf diese Weise koppeln Sie eine Zahlungsart an Warenkorb-Eigenschaften, ohne die Prüflogik zu duplizieren. Die eigentlichen Bedingungen (Produktfelder, Freifelder, Wertevergleiche) werden zentral in checkout.productDependency gepflegt.

Beispielkonfiguration

Die Option “Kauf auf Rechnung” soll gesperrt werden, sobald sich ein personalisiertes Produkt (z.B. mit Gravur) im Warenkorb befindet. Weil personalisierte Artikel nicht retournierbar sind, tragen sie ein höheres Zahlungsausfallrisiko. Die Bedingung “keine Gravur im Warenkorb” definieren Sie in checkout.productDependency und referenzieren sie anschließend hier.

"validations": [
  {
    "options": {
      "list": [
        "checkout.productDependency.noEngraving"
      ]
    },
    "service": "paymentValidation.productDependency"
  }
]

Parameterübersicht

Parameter	Beschreibung
`list`	Liste mit IDs der Konfigurationen aus checkout.productDependency, die geprüft werden sollen. Damit die Validierung erfolgreich ist und die Zahlungsart angeboten wird, müssen alle hier angegebenen Werte erfüllt sein.

`paymentValidation.userAgent` - Validierung des User-Agents für Zahlungsarten

Prüft, ob eine Zahlungsart basierend auf dem genutzten Gerät oder Browser des Kunden angezeigt wird. Geräte und Browser übermitteln beim Seitenaufruf automatisch eine technische Kennung, den sogenannten User-Agent. Anhand dieser Kennung lässt sich z.B. erkennen, ob jemand ein iPhone, ein iPad oder einen Mac verwendet. Die in userAgents eingetragenen Begriffe werden gegen diese Kennung geprüft, ein Treffer genügt. So lässt sich eine Zahlungsart gezielt nur für bestimmte Geräte oder Browser freischalten oder sperren, z.B. wenn Apple Pay nur für Kunden angezeigt werden soll, die ein Apple-Gerät oder einen kompatiblen Browser verwenden.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "userAgents": [
        "Macintosh",
        "Mac OS X",
        "iPhone",
        "iPad"
      ],
      "rule": "allow"
    },
    "service": "paymentValidation.userAgent"
  }
]

Parameterübersicht

Parameter	Beschreibung
`userAgents`	Liste von Begriffen, die in der Gerät-/Browser-Kennung des Kunden gesucht werden. Ein Treffer genügt. Die Werte sind nicht durch WEBSALE vorgegeben, sondern entsprechen den tatsächlichen Zeichenketten, die das jeweilige Gerät oder der Browser übermittelt. Die korrekten Werte müssen selbst am jeweiligen Gerät ermittelt werden, z.B. über die Browser-Konsole.
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Zahlart wird nur angezeigt, wenn mindestens ein Begriff aus `userAgents` erkannt wird. - `deny` - Zahlart wird ausgeblendet, wenn ein Treffer gefunden wird.

`paymentFieldDisplayCheck.*` - Anzeigebedingungen für Zusatzfelder

paymentFieldDisplayCheck.* enthält Bedingungen, die steuern, wann ein Zusatzfeld einer Zahlungsart im Checkout angezeigt wird. So erscheint ein Feld beispielsweise nur für bestimmte Rechnungsländer oder nur dann, wenn ein anderes Zusatzfeld einen bestimmten Wert hat. Die Bedingungen werden in der Felddefinition unter displayConditions eingetragen. Sind mehrere Bedingungen hinterlegt, müssen alle erfüllt sein. Anders als die Prüfungen unter validations erzeugen die Bedingungen keine Fehlermeldung. Ist eine Bedingung nicht erfüllt, blendet der Shop das Feld aus, prüft es nicht und verlangt es auch als Pflichtfeld nicht. Kann eine Bedingung nicht ausgewertet werden, gilt sie als nicht erfüllt und das Feld bleibt ausgeblendet. Das betrifft beispielsweise eine Adresse, die sich nicht laden lässt, oder eine unvollständige Konfiguration. Die Ursache steht dann im LogManager.

`paymentFieldDisplayCheck.billCountry` / `shippingCountry` - Land der Rechnungs- oder Lieferadresse

Prüft das Land der im Checkout gewählten Rechnungsadresse (billCountry) oder Lieferadresse (shippingCountry) gegen eine Länderliste.

Beispielkonfiguration

"displayConditions": [
  {
    "options": {
      "countryList": [
        "general.country.de",
        "general.country.at"
      ],
      "rule": "allow"
    },
    "service": "paymentFieldDisplayCheck.billCountry"
  }
]

Parameterübersicht

Parameter	Beschreibung
`countryList`	Liste der Länder als Knoten-IDs aus `general.country`, beispielsweise `general.country.de`. Das Land der Adresse wird über das zwei- oder dreistellige ISO-Kürzel oder den numerischen ISO-Code einem aktiven Länderknoten zugeordnet.
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Das Feld wird nur für Länder aus `countryList` angezeigt. - `deny` - Das Feld wird für Länder aus `countryList` ausgeblendet. Bei einem anderen Wert bleibt das Feld ausgeblendet.

Die Bedingung ist nicht erfüllt, wenn sich die Adresse nicht laden lässt oder ihr Land nicht als aktiver Länderknoten konfiguriert ist.

Ohne abweichende Lieferadresse prüft shippingCountry das Land der Rechnungsadresse.

`paymentFieldDisplayCheck.billAddressField` / `shippingAddressField` - Feld der Rechnungs- oder Lieferadresse

Prüft ein einzelnes Feld der im Checkout gewählten Rechnungsadresse (billAddressField) oder Lieferadresse (shippingAddressField).

Beispielkonfiguration

Das Feld wird nur angezeigt, wenn die Rechnungsadresse keine Firma enthält:

"displayConditions": [
  {
    "options": {
      "field": "company",
      "type": "empty"
    },
    "service": "paymentFieldDisplayCheck.billAddressField"
  }
]

Parameterübersicht

Parameter	Beschreibung
`field`	Name des Adressfeldes. Für Standardfelder der Basisname, beispielsweise `company` oder `zip`. Für Zusatzfelder der Adresse `custom.<name>`.
`type`	Art des Vergleichs. Mögliche Werte: - `filled` - Feld ist nicht leer - `empty` - Feld ist leer - `value` / `notvalue` - Wert ist gleich bzw. ungleich `value` - `inlist` / `notinlist` - Wert ist in `list` enthalten bzw. nicht enthalten - `prefix` / `notprefix` - Wert beginnt bzw. beginnt nicht mit `value`
`value`	Vergleichswert für `value`, `notvalue`, `prefix` und `notprefix`.
`list`	Werteliste für `inlist` und `notinlist`. Ist die Liste leer oder fehlt sie, gilt die Bedingung bei beiden Typen als erfüllt.

Die Bedingung ist nicht erfüllt, wenn sich die Adresse nicht laden lässt, field oder type fehlt, das Feld in der Adresse nicht existiert oder type einen unbekannten Wert hat.

`paymentFieldDisplayCheck.paymentField` - Wert eines anderen Zusatzfeldes

Prüft den aktuellen Wert eines anderen Zusatzfeldes aus dem laufenden Checkout. Damit lassen sich abhängige Felder bauen, die erst nach einer bestimmten Eingabe erscheinen.

Beispielkonfiguration

Das Feld wird nur angezeigt, wenn im Zusatzfeld invoiceToCompany die Checkbox gesetzt ist:

"displayConditions": [
  {
    "options": {
      "field": "invoiceToCompany",
      "type": "value",
      "value": "true"
    },
    "service": "paymentFieldDisplayCheck.paymentField"
  }
]

Parameterübersicht

Parameter	Beschreibung
`field`	Technischer Name (`name`) des anderen Zusatzfeldes aus `payment.paymentField`.
`type`	Art des Vergleichs. Es gelten dieselben acht Werte wie bei `billAddressField` weiter oben.
`value`	Vergleichswert für `value`, `notvalue`, `prefix` und `notprefix`. Checkboxen liefern den Wert `true` oder `false` als Text.
`list`	Werteliste für `inlist` und `notinlist`. Ist die Liste leer oder fehlt sie, gilt die Bedingung als erfüllt.

Die Bedingung ist nicht erfüllt, wenn field oder type fehlt oder type einen unbekannten Wert hat.

Der Shop speichert den Wert eines Zusatzfeldes erst mit der Aktion CheckoutSetPaymentFields. Ein abhängiges Feld erscheint daher erst, nachdem das Formular abgeschickt wurde, beispielsweise automatisch bei jeder Änderung.

`shippingMethodValidation.*` - Versandarten-Validierung

shippingMethodValidation.* enthält Regeln, mit denen festgelegt wird, ob eine Versandart im Checkout erlaubt ist. Die Prüfung kann z.B. vom Lieferland, vom Warenwert, von Produkttypen oder von der gewählten Zahlungsart abhängen. Diese Regeln können in der Konfiguration der jeweiligen Versandart unter validations eingetragen werden. Das Frontend stellt dann nur die Versandarten bereit, die zu den aktuellen Bedingungen passen. Auswertung im Frontend Im Template werden die konfigurierten Regeln über die Methode $wsCheckout.isValidShippingMethod(shippingMethodId) ausgewertet (gleiches Muster wie bei den Zahlungsarten). Die Gründe für eine deaktivierte Versandart lassen sich zusätzlich über $wsCheckout.getShippingMethodDisabledErrors(shippingMethodId) ausgeben.

`shippingMethodValidation.shippingCountry` - Validierung des Landes (Lieferadresse)

Beispielkonfiguration

"validations": [
  {
    "options": {
      "countryList": [
        "general.country.de",
        "general.country.at"
      ],
      "rule": "allow"
    },
    "service": "shippingMethodValidation.shippingCountry"
  }
]

Parameterübersicht

Parameter	Beschreibung
`countryList`	Liste der Länder, auf die diese Regel angewendet werden soll, als Knoten-IDs aus `general.country` (beispielsweise `general.country.de`). Das Land der Adresse wird über das zwei- oder dreistellige ISO-Kürzel oder den numerischen ISO-Code einem aktiven Länderknoten zugeordnet.
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Länder, die in `countryList` stehen, sind erlaubt. - `deny` - Länder, die in `countryList` stehen, sind nicht erlaubt.

`shippingMethodValidation.paymentMethod` - Validierung der Zahlungsart für Versandarten

Prüft, ob eine Versandart nur mit bestimmten Zahlungsarten verwendet werden darf.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "paymentMethods": [
        "payment.method.invoice",
        "payment.method.prepayment"
      ],
      "rule": "allow"
    },
    "service": "shippingMethodValidation.paymentMethod"
  }
]

Parameterübersicht

Parameter	Beschreibung
`paymentMethods`	Liste der Zahlungsarten-IDs, die auf diese Regel angewendet werden. Die IDs entsprechen den internen Namen der Zahlungsarten (z.B. `payment.method.invoice`)
`rule`	Steuerung der Regel. Mögliche Werte: - `allow` - Zahlungsarten, die in `paymentMethods` stehen, sind erlaubt. - `deny` - Zahlungsarten, die in `paymentMethods` stehen, sind nicht erlaubt.

`shippingMethodValidation.valueOfGoods` - Validierung des Mindest-/Maximalbestellwerts für Versandarten

Prüft, ob die Versandart nur verwendet werden darf, wenn ein bestimmter Mindest- oder Maximalbestellwert erreicht bzw. überschritten wird.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "valueOfGoods": 100,
      "type": "min"
    },
    "service": "shippingMethodValidation.valueOfGoods"
  }
]

Parameterübersicht

Parameter	Beschreibung
`valueOfGoods`	Grenzwert der Gesamtsumme (Warenwert), ab bzw. bis zu der die Versandart erlaubt ist.
`type`	Art der Prüfung. Mögliche Werte: - „`min`” - Die Versandart ist nur erlaubt, wenn der Bestellwert mindestens `valueOfGoods` erreicht. - „`max`” - Die Versandart ist nur erlaubt, wenn der Bestellwert `valueOfGoods` nicht überschreitet.

`shippingMethodValidation.productType` - Validierung des Produkttyps für Versandarten

Prüft, ob alle Produkte im Warenkorb einen passenden Produkttyp haben.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "rule": "allow",
      "ruleList": [
        "productType.digital"
      ],
      "includeList": [
        "productType.service"
      ]
    },
    "service": "shippingMethodValidation.productType"
  }
]

Parameterübersicht

Parameter	Beschreibung
`rule`	Art der Prüfung. Mögliche Werte: - „`allow`” - Nur Produkttypen aus `ruleList` und `includeList` sind erlaubt. - „`deny`” - Produkttypen aus `ruleList` sind nicht erlaubt. Ausnahme: Produkttypen aus `includeList` sind immer erlaubt.
`ruleList`	Liste der Produkttypen, die - abhängig von `rule` - erlaubt oder nicht erlaubt sind.
`includeList`	Liste der Produkttypen, die immer erlaubt sind.

`shippingMethodValidation.productDependency` - Validierung der Produkt-Abhängigkeiten für Versandarten

Prüft die Produkte im Warenkorb anhand der Konfiguration checkout.productDependency.

Beispielkonfiguration

"validations": [
  {
    "options": {
      "list": [
        "checkout.productDependency.digitalOnly",
        "checkout.productDependency.noBulkyGoods"
      ]
    },
    "service": "shippingMethodValidation.productDependency"
  }
]

Parameterübersicht

Parameter	Beschreibung
`list`	Liste mit IDs der Konfigurationen aus `checkout.productDependency`, die geprüft werden sollen. Damit die Validierung erfolgreich ist, müssen alle hier angegebenen Werte erfüllt sein.

`shippingMethodValidation.expressCheckout` - Validierung des Express-Checkout für Versandarten

Prüft, ob eine Versandart abhängig von der im Express-Checkout verwendeten Zahlungsart erlaubt ist. Die Prüfung greift bei PayPal Express sowie Apple Pay und Google Pay Express (PayPal Commerce Platform).

Beispielkonfiguration

Die Versandart soll nicht wählbar sein, wenn der Kunde den Bestellvorgang als PayPal-Express-Checkout durchläuft:

"validations": [
  {
    "options": {
      "rule": "deny",
      "ruleList": [
        "paypalCheckout"
      ]
    },
    "service": "shippingMethodValidation.expressCheckout"
  }
]

Parameterübersicht

Parameter	Beschreibung
`rule`	Art der Prüfung. Mögliche Werte: - „`deny`” - Läuft der Bestellvorgang als Express-Checkout mit einer Zahlungsart aus `ruleList`, ist die Versandart gesperrt. Außerhalb des Express-Checkouts ist die Versandart erlaubt. - „`allow`” - Die Versandart ist nur erlaubt, wenn der Bestellvorgang als Express-Checkout mit einer Zahlungsart aus `ruleList` läuft. Im normalen Checkout (kein Express-Checkout aktiv) ist die Versandart damit immer gesperrt - `allow` definiert also eine reine Express-Checkout-Versandart.
`ruleList`	Liste der Zahlungsarten-IDs, die - abhängig von `rule` - im Express-Checkout erlaubt bzw. verboten sind. Die IDs entsprechen den Kennungen der Zahlarten aus payment.payment (z.B. `paypalCheckout`).

Schlägt die Prüfung fehl, liefert die Validierung den Fehler expressCheckoutDenied bzw. expressCheckoutNotAllowed. Im Frontend lässt er sich über $wsCheckout.getShippingMethodDisabledErrors() ausgeben.

`payment.*` - Online-Clearing-Services

Ein Online-Clearing-Service wickelt die Zahlung einer Zahlungsart in Echtzeit über einen Zahlungsanbieter ab. Die Zuordnung erfolgt in der Zahlungsart unter payment.payment im Feld onlineClearing. Zahlungsarten ohne onlineClearing gelten als Offline-Zahlungsarten, beispielsweise Vorkasse oder Rechnung ohne Anbieter. Anders als die Validierungs- und Prüfservices wird ein Online-Clearing-Service nicht in einer Liste validations, sondern über ein Feld vom Typ singleService referenziert. Jede Zahlungsart verweist auf genau einen Service. Die anbieterspezifischen Einstellungen stehen in den Knoten payment.computopHosted, payment.stripe und payment.payPalCheckout. Die Optionen des Services regeln nur, auf welche Seiten des Shops der Kunde während der Zahlung geleitet wird.

Ausstehende Zahlungen und Pending-Seite

Alle drei Services kennen eine Pending-Seite. Der Shop zeigt sie an, solange eine Zahlung beim Anbieter noch nicht abgeschlossen ist. In dieser Zeit ist die Session gesperrt. Der Kunde kann dann nur die Pending-Seite, die Bestellbestätigung, den Bestellablauf und die Startseite aufrufen. Ruft er eine andere Seite auf, leitet der Shop ihn zurück auf die Pending-Seite. Der Shop hängt an die URL der Pending-Seite den Parameter wsPaymentStatus=refresh an. Ist die Zahlung inzwischen abgeschlossen, leitet der Shop beim Aufruf der Pending-Seite direkt auf die Bestellbestätigung weiter. Ist in den Service-Optionen keine Pending-Seite hinterlegt, greift der Shop auf das Feld pendingTemplate im Knoten general.subshopView zurück. Die genaue Reihenfolge je Anbieter beschreiben die folgenden Abschnitte.

`payment.computop-hosted` - Computop Hosted Payment Page

Leitet den Kunden auf die gehostete Bezahlseite von Computop. Der Shop rendert dafür zuerst eine eigene Seite mit einem Formular, das die Zahlungsdaten per POST an Computop übergibt. Diese Seite wird über die Option view festgelegt. Die ID der Zahlungsart unter payment.payment muss mit der id eines Eintrags unter payment.computopHosted übereinstimmen und einer von Computop unterstützten Zahlart entsprechen. Andernfalls bricht der Shop die Zahlung mit der Log-Meldung payment method invalid, not defined in computopHosted config ab.

Beispielkonfiguration (`payment.payment.creditcard` → `onlineClearing`)

"onlineClearing": {
  "service": "payment.computop-hosted",
  "options": {
    "view": "computop_redirect.htm",
    "pendingView": "computop_pending.htm"
  }
}

Parameterübersicht

Parameter	Beschreibung
`view`	Template (View) mit dem POST-Formular an Computop. Der Shop leitet den Kunden nach dem Absenden der Bestellung auf diese Seite.
`pendingView`	Template (View), das der Kunde sieht, solange die Zahlung noch aussteht. Optional. Ist der Wert leer, nutzt der Shop `pendingTemplate` aus `general.subshopView`. Ist auch dieses leer, bleibt der Kunde auf der Bestellbestätigung.

`payment.stripe` - Stripe

Bindet Stripe als Zahlungsanbieter an. Die Zahlung läuft über das Stripe-Widget im Bestellablauf. Wählt der Kunde im Widget eine Zahlungsmöglichkeit mit Weiterleitung, kehrt er über die Seite aus der Option view in den Shop zurück. Die Einstellungen zum Stripe-Konto stehen im Knoten payment.stripe. Den Einbau im Template beschreibt Stripe im Frontend.

Beispielkonfiguration (`payment.payment.stripe` → `onlineClearing`)

"onlineClearing": {
  "service": "payment.stripe",
  "options": {
    "view": "stripe_pending.htm"
  }
}

Parameterübersicht

Parameter	Beschreibung
`view`	Template (View), auf das Stripe den Kunden nach der Zahlung zurückleitet und das als Pending-Seite dient. Optional. Der Shop baut daraus die Rückkehr-Adresse mit dem Parameter `wsPaymentStatus=refresh`. Ist der Wert leer, übergibt der Shop keine eigene Rückkehr-Adresse an Stripe.

`payment.paypal-checkout` - PayPal Checkout

Bindet PayPal Checkout (PayPal Commerce Platform) als Zahlungsanbieter an. Die Rückkehr-Seiten für Bestätigung, Abbruch und Fehler legt der Knoten payment.payPalCheckout fest. Die Option view des Services legt die Seite für Zahlungen fest, die nach dem Absenden noch ausstehen, beispielsweise beim Kauf auf Rechnung über PayPal.

Beispielkonfiguration (`payment.payment.paypalCheckout` → `onlineClearing`)

"onlineClearing": {
  "service": "payment.paypal-checkout",
  "options": {
    "view": "paypal_checkout_pending.htm"
  }
}

Parameterübersicht

Parameter	Beschreibung
`view`	Template (View), das der Kunde sieht, solange die Zahlung noch aussteht. Optional. Ist der Wert leer, nutzt der Shop `pendingTemplate` aus `payment.payPalCheckout`. Ist auch dieses leer, nutzt er `pendingTemplate` aus `general.subshopView`.
`clearingFields`	Nur für PayPal Kauf auf Rechnung: ordnet die Angaben Geburtsdatum (`birthdate`) und Telefonnummer (`phone`) je einem Zusatzfeld der Zahlungsart zu. Eingetragen wird der technische Name des Zusatzfeldes. Optional. Siehe Beispiel: PayPal Kauf auf Rechnung.

`captchaCheck.*` - Captcha-Prüfung

Ein Captcha-Service prüft, ob eine Anfrage von einem Menschen stammt. Das Frontend bindet dafür das Captcha des Anbieters ein und schickt dessen Token mit der Aktion an den Shop. Der Service reicht das Token zur Prüfung an den Anbieter weiter. Die Zugangsdaten des Anbieters liegen im Knoten security. Welcher Anbieter an einer Stelle prüft, legt der Verweis auf den Service fest. Drei Stellen können einen Captcha-Service verwenden:

inquiry.form im Feld captcha schützt ein Formular. Die Prüfung läuft bei jeder Ausführung der Aktion InquirySend.
payment.paymentBlock im Feld captcha sichert den Bestellabschluss gegen wiederholte Zahlungsversuche. Die Prüfung läuft erst, wenn der Shop nach mehreren Fehlversuchen ein Captcha verlangt. Ob das der Fall ist, gibt $wsCheckout.paymentCaptchaRequired aus.
security.actionGuard im Feld captcha schützt eine beliebige Aktion.

Beispielkonfiguration (`inquiry.form.contact` → `captcha`)

"captcha": {
  "service": "captchaCheck.friendlyCaptchaV1"
}

Beide Services prüfen zuerst die Cookie-Einwilligung. Fehlt die Einwilligung für den Consent-Service, dessen Name im Feld name des Anbieterknotens steht, schlägt die Prüfung ohne Anfrage beim Anbieter fehl. Das Feld name muss deshalb mit dem Namen des Dienstes in der Consent-Verwaltung übereinstimmen. Das Token erwartet der Shop in einem fest vorgegebenen Request-Parameter der Aktion. Der Name lässt sich nicht konfigurieren.

Service	Anbieterknoten	Request-Parameter
`captchaCheck.recaptchav3`	`security.recaptchav3`	`wscaptchatoken`
`captchaCheck.friendlyCaptchaV1`	`security.friendlyCaptchaV1`	`frc-captcha-solution`

Schlägt die Prüfung bei InquirySend oder beim Bestellabschluss fehl, liefert die Aktion den Fehlercode captchaFailed. Den Text dazu pflegen Sie im Fehlertext-Knoten der Aktion, beispielsweise unter actions.inquirySend.

`captchaCheck.recaptchav3` - Google reCAPTCHA v3

Prüft ein Token von Google reCAPTCHA v3. Google liefert zu jedem Token eine Bewertung zwischen 0.0 und 1.0. Liegt sie unter minimumScore aus security.recaptchav3, gilt die Prüfung als fehlgeschlagen.

Beispielkonfiguration

"captcha": {
  "service": "captchaCheck.recaptchav3"
}

Parameterübersicht

Parameter	Beschreibung
`errorMessage`	Fehlertext des Services. Optional. Die Aktionen `InquirySend` und `CheckoutConfirm` geben bei fehlgeschlagener Prüfung stattdessen den Text zum Fehlercode `captchaFailed` aus.

`captchaCheck.friendlyCaptchaV1` - Friendly Captcha v1

Prüft eine Lösung von Friendly Captcha v1. Der Shop sendet die Lösung zusammen mit apiKey und siteKey aus security.friendlyCaptchaV1 an die verifyUrl des Anbieters.

Beispielkonfiguration

"captcha": {
  "service": "captchaCheck.friendlyCaptchaV1"
}

Parameterübersicht

Parameter	Beschreibung
`errorMessage`	Fehlertext des Services. Optional. Die Aktionen `InquirySend` und `CheckoutConfirm` geben bei fehlgeschlagener Prüfung stattdessen den Text zum Fehlercode `captchaFailed` aus.

`unitConverter.*` - Einheitenumrechnung

Ein Kundendatenfeld vom Typ number kann eine dynamische Einheit haben. Der Kunde wählt dann die Einheit aus einer Liste, beispielsweise Meter oder Zentimeter. Wechselt er die Einheit, rechnet ein Umrechnungsservice den eingegebenen Wert in die neue Einheit um. Der Service wird im Kundendatenfeld unter customer.customerDataField im Feld type.number.unit.dynamic.converter eingetragen. Ohne Eintrag speichert der Shop den Wert unverändert mit der neuen Einheit.

`unitConverter.orderOfMagnitude` - Umrechnung über Faktoren

Rechnet über die Faktoren, die an den Einheiten unter unitOptions hinterlegt sind. Der Service selbst hat keine Optionen. Die Umrechnung folgt der Formel:

neuer Wert = Wert × Faktor der gewählten Einheit ÷ Faktor der vorherigen Einheit

Als vorherige Einheit gilt die Einheit aus der Session. Ist dort keine hinterlegt, nimmt der Shop die im Kundenkonto gespeicherte Einheit. Ist auch dort keine bekannt, rechnet er mit dem Faktor 1. Ist der Faktor der vorherigen Einheit 0, ergibt die Umrechnung 0. Der Faktor gibt an, wie viele Einheiten einer Bezugsgröße entsprechen. Geben Sie der Basiseinheit aus baseUnitName deshalb den Faktor 1. So stimmt auch die Umrechnung, wenn keine vorherige Einheit bekannt ist.

Beispielkonfiguration (`customer.customerDataField.raumhoehe` → `type`)

"number": {
  "numDecimals": 2,
  "unit": {
    "dynamic": {
      "baseUnitName": "m",
      "unitOptions": [
        { "name": "m", "label": "<Textbaustein>", "factor": 1 },
        { "name": "cm", "label": "<Textbaustein>", "factor": 100 },
        { "name": "mm", "label": "<Textbaustein>", "factor": 1000 }
      ],
      "converter": {
        "service": "unitConverter.orderOfMagnitude"
      }
    }
  }
}

Hat der Kunde 2.5 in Metern eingegeben und wechselt auf Zentimeter, speichert der Shop 2.5 × 100 ÷ 1 = 250.

Parameterübersicht

Parameter	Beschreibung
—	Keine Parameter. Die Faktoren stammen aus `unitOptions[].factor` des Kundendatenfelds.

​addressCheck.* - Adressvalidierungen

​addressCheck.minLength - Mindestlänge

​Beispielkonfiguration für (accounts.addressField.firstName)

​Parameterübersicht

​addressCheck.maxLength - Maximallänge

​Beispielkonfiguration für (accounts.addressField.firstName)

​Parameterübersicht

​addressCheck.numeric - Nur Ziffern

​Beispielkonfiguration für (accounts.addressField.phone)

​Parameterübersicht

​addressCheck.country - Ländercode (ISO)

​Beispielkonfiguration für (accounts.addressField.country)

​Parameterübersicht

​addressCheck.zip - Postleitzahl (PLZ)

​Beispielkonfiguration für (accounts.addressField.zip)

​Parameterübersicht

​addressCheck.salutation - Anrede (Code)

​Beispielkonfiguration für (accounts.addressField.salutationCode)

​Parameterübersicht

​addressCheck.regex - Regulärer Ausdruck

​Beispielkonfiguration für (accounts.addressField.additionalInfo)

​Parameterübersicht

​addressCheck.phone - Telefonnummer

​Beispielkonfiguration für (accounts.addressField.phone)

​Parameterübersicht

​addressCheck.alpha - Nur Buchstaben (A–Z)

​Beispielkonfiguration für (accounts.addressField.additionalInfo)

​Parameterübersicht

​addressCheck.alphanum - Buchstaben/Ziffern (A–Z/0–9)

​Beispielkonfiguration für (accounts.addressField.additionalInfo)

​Parameterübersicht

​addressCheck.legalSigns - Erlaubte Zeichen

​Beispielkonfiguration für (accounts.addressField.additionalInfo)

​Parameterübersicht

​addressCheck.illegalSigns - Verbotene Zeichen

​Beispielkonfiguration für (accounts.addressField.phone)

​Parameterübersicht

​addressCheck.date - Datum

​Beispielkonfiguration für (accounts.addressField.additionalInfo)

​Parameterübersicht

​addressCheck.allowedSelection - Auswahl (Listenelement)

​Beispielkonfiguration für (accounts.addressField.addressType)

​Parameterübersicht

​dataChecker.* - Allgemeine Feldvalidierungen

​dataChecker.minLength - Mindestlänge

​Beispielkonfiguration für (inquiry.form.catalogue.fields.firstName)

​Parameterübersicht

​dataChecker.maxLength - Maximallänge

​Beispielkonfiguration für (inquiry.form.catalogue.fields.firstName)

​Parameterübersicht

​dataChecker.numericChecker - Nur Ziffern

​Beispielkonfiguration für (inquiry.form.catalogue.fields.phone)

​Parameterübersicht

​dataChecker.countryChecker - Ländercode (ISO)

​Beispielkonfiguration für (inquiry.form.catalogue.fields.country)

​Parameterübersicht

​dataChecker.zipCodeChecker - Postleitzahl (PLZ)

​Beispielkonfiguration für (inquiry.form.catalogue.fields.zip)

​Parameterübersicht

​dataChecker.salutation - Anrede (Code)

​Beispielkonfiguration für (inquiry.form.catalogue.fields.salutation)

​Parameterübersicht

​dataChecker.regex - Regulärer Ausdruck

​Beispielkonfiguration für (inquiry.form.catalogue.fields.additionalInfo)

​Parameterübersicht

​dataChecker.email - E‑Mail-Adresse

​Beispielkonfiguration für (inquiry.form.catalogue.fields.mail)

​Parameterübersicht

​dataChecker.alphaClass - Buchstaben (min/verschiedene)

​Beispielkonfiguration für (inquiry.form.catalogue.fields.additionalInfo)

​Parameterübersicht

​dataChecker.lowerAlphaClass - Kleinbuchstaben

​Beispielkonfiguration für (inquiry.form.catalogue.fields.additionalInfo)

​Parameterübersicht

​dataChecker.upperAlphaClass - Großbuchstaben

​Beispielkonfiguration für (inquiry.form.catalogue.fields.additionalInfo)

​Parameterübersicht

​dataChecker.digitClass - Ziffern

​Beispielkonfiguration für (inquiry.form.catalogue.fields.additionalInfo)

​Parameterübersicht

`addressCheck.*` - Adressvalidierungen

`addressCheck.minLength` - Mindestlänge

Beispielkonfiguration für (`accounts.addressField.firstName`)

Parameterübersicht

`addressCheck.maxLength` - Maximallänge

Beispielkonfiguration für (`accounts.addressField.firstName`)

Parameterübersicht

`addressCheck.numeric` - Nur Ziffern

Beispielkonfiguration für (`accounts.addressField.phone`)

Parameterübersicht

`addressCheck.country` - Ländercode (ISO)

Beispielkonfiguration für (`accounts.addressField.country`)

Parameterübersicht

`addressCheck.zip` - Postleitzahl (PLZ)

Beispielkonfiguration für (`accounts.addressField.zip`)

Parameterübersicht

`addressCheck.salutation` - Anrede (Code)

Beispielkonfiguration für (`accounts.addressField.salutationCode`)

Parameterübersicht

`addressCheck.regex` - Regulärer Ausdruck

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

Parameterübersicht

`addressCheck.phone` - Telefonnummer

Beispielkonfiguration für (`accounts.addressField.phone`)

Parameterübersicht

`addressCheck.alpha` - Nur Buchstaben (A–Z)

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

Parameterübersicht

`addressCheck.alphanum` - Buchstaben/Ziffern (A–Z/0–9)

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

Parameterübersicht

`addressCheck.legalSigns` - Erlaubte Zeichen

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

Parameterübersicht

`addressCheck.illegalSigns` - Verbotene Zeichen

Beispielkonfiguration für (`accounts.addressField.phone`)

Parameterübersicht

`addressCheck.date` - Datum

Beispielkonfiguration für (`accounts.addressField.additionalInfo`)

Parameterübersicht

`addressCheck.allowedSelection` - Auswahl (Listenelement)

Beispielkonfiguration für (`accounts.addressField.addressType`)

Parameterübersicht

`dataChecker.*` - Allgemeine Feldvalidierungen

`dataChecker.minLength` - Mindestlänge

Beispielkonfiguration für (`inquiry.form.catalogue.fields.firstName`)

Parameterübersicht

`dataChecker.maxLength` - Maximallänge

Beispielkonfiguration für (`inquiry.form.catalogue.fields.firstName`)

Parameterübersicht

`dataChecker.numericChecker` - Nur Ziffern

Beispielkonfiguration für (`inquiry.form.catalogue.fields.phone`)

Parameterübersicht

`dataChecker.countryChecker` - Ländercode (ISO)

Beispielkonfiguration für (`inquiry.form.catalogue.fields.country`)

Parameterübersicht

`dataChecker.zipCodeChecker` - Postleitzahl (PLZ)

Beispielkonfiguration für (`inquiry.form.catalogue.fields.zip`)

Parameterübersicht

`dataChecker.salutation` - Anrede (Code)

Beispielkonfiguration für (`inquiry.form.catalogue.fields.salutation`)

Parameterübersicht

`dataChecker.regex` - Regulärer Ausdruck

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

Parameterübersicht

`dataChecker.email` - E‑Mail-Adresse

Beispielkonfiguration für (`inquiry.form.catalogue.fields.mail`)

Parameterübersicht

`dataChecker.alphaClass` - Buchstaben (min/verschiedene)

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

Parameterübersicht

`dataChecker.lowerAlphaClass` - Kleinbuchstaben

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

Parameterübersicht

`dataChecker.upperAlphaClass` - Großbuchstaben

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

Parameterübersicht

`dataChecker.digitClass` - Ziffern

Beispielkonfiguration für (`inquiry.form.catalogue.fields.additionalInfo`)

Parameterübersicht