Skip to main content

InstrumentValidationRule

Instrument validation rules contain backend defined rules, that allow frontend validation of payment instruments during the payment process.

The rules are attached to payment option and each specific payment instrument applicable for the payment (e.g. deposit or withdrawal).

If payment option supports multiple payment instrument types, each has its own validation rules.

instrumentTypeInstrumentType (string)

Represents the type of the instrument.

ValueDescription
SEPA_BANK_ACCOUNTSEPA Bank account
UK_BANK_ACCOUNTUK Bank account
US_BANK_ACCOUNTUS Bank account
CCI_BANK_ACCOUNTCCI Bank account
BR_BANK_ACCOUNTBR Bank account
PH_BANK_ACCOUNTPH Bank account
CLABE_BANK_ACCOUNTCLABE Bank account
CARDCard
QR_CODEQR Code

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, CCI_BANK_ACCOUNT, BR_BANK_ACCOUNT, PH_BANK_ACCOUNT, CLABE_BANK_ACCOUNT, CARD, QR_CODE]

Example: CARD
fields object[]
  • Array [
    • fieldNamestring

    Field name.

    Example: iban
    validations object[]
  • Array [
    • oneOf
    idstringrequired

    Validation rule id. Can be used to identify the validation.

    Example: VALID_IBAN
    messagestringrequired

    Human readable validation error message in English.

    Example: Please enter valid IBAN.
    regexpstringrequired

    Regular expression for the validation

    Example: ^AL\d{10}[0-9A-Z]{16}$|^AD\d{10}[0-9A-Z]{12}$|^AT\d{18}$|^BH\d{2}[A-Z]{4}[0-9A-Z]{14}$|^BE\d{14}$|^BA\d{18}$|^BG\d{2}[A-Z]{4}\d{6}[0-9A-Z]{8}$|^HR\d{19}$|^CY\d{10}[0-9A-Z]{16}$|^CZ\d{22}$|^DK\d{16}$|^FO\d{16}$|^GL\d{16}$|^DO\d{2}[0-9A-Z]{4}\d{20}$|^EE\d{18}$|^FI\d{16}$|^FR\d{12}[0-9A-Z]{11}\d{2}$|^GE\d{2}[A-Z]{2}\d{16}$|^DE\d{20}$|^GI\d{2}[A-Z]{4}[0-9A-Z]{15}$|^GR\d{9}[0-9A-Z]{16}$|^HU\d{26}$|^IS\d{24}$|^IE\d{2}[A-Z]{4}\d{14}$|^IL\d{21}$|^IT\d{2}[A-Z]\d{10}[0-9A-Z]{12}$|^[A-Z]{2}\d{5}[0-9A-Z]{13}$|^KW\d{2}[A-Z]{4}22!$|^LV\d{2}[A-Z]{4}[0-9A-Z]{13}$|^LB\d{6}[0-9A-Z]{20}$|^LI\d{7}[0-9A-Z]{12}$|^LT\d{18}$|^LU\d{5}[0-9A-Z]{13}$|^MK\d{5}[0-9A-Z]{10}\d{2}$|^MT\d{2}[A-Z]{4}\d{5}[0-9A-Z]{18}$|^MR13\d{23}$|^MU\d{2}[A-Z]{4}\d{19}[A-Z]{3}$|^MC\d{12}[0-9A-Z]{11}\d{2}$|^ME\d{20}$|^NL\d{2}[A-Z]{4}\d{10}$|^NO\d{13}$|^PL\d{10}[0-9A-Z]{,16}n$|^PT\d{23}$|^RO\d{2}[A-Z]{4}[0-9A-Z]{16}$|^SM\d{2}[A-Z]\d{10}[0-9A-Z]{12}$|^SA\d{4}[0-9A-Z]{18}$|^RS\d{20}$|^SK\d{22}$|^SI\d{17}$|^ES\d{22}$|^SE\d{22}$|^CH\d{7}[0-9A-Z]{12}$|^TN59\d{20}$|^TR\d{7}[0-9A-Z]{17}$|^AE\d{21}$|^GB\d{2}[A-Z]{4}\d{14}$
  • ]
  • ]
    • InstrumentValidationRule
    {
      "instrumentType": "CARD",
      "fields": [
        {
          "fieldName": "iban",
          "validations": [
            {
              "id": "VALID_IBAN",
              "message": "Please enter valid IBAN.",
              "regexp": "^ALd{10}[0-9A-Z]{16}$|^ADd{10}[0-9A-Z]{12}$|^ATd{18}$|^BHd{2}[A-Z]{4}[0-9A-Z]{14}$|^BEd{14}$|^BAd{18}$|^BGd{2}[A-Z]{4}d{6}[0-9A-Z]{8}$|^HRd{19}$|^CYd{10}[0-9A-Z]{16}$|^CZd{22}$|^DKd{16}$|^FOd{16}$|^GLd{16}$|^DOd{2}[0-9A-Z]{4}d{20}$|^EEd{18}$|^FId{16}$|^FRd{12}[0-9A-Z]{11}d{2}$|^GEd{2}[A-Z]{2}d{16}$|^DEd{20}$|^GId{2}[A-Z]{4}[0-9A-Z]{15}$|^GRd{9}[0-9A-Z]{16}$|^HUd{26}$|^ISd{24}$|^IEd{2}[A-Z]{4}d{14}$|^ILd{21}$|^ITd{2}[A-Z]d{10}[0-9A-Z]{12}$|^[A-Z]{2}d{5}[0-9A-Z]{13}$|^KWd{2}[A-Z]{4}22!$|^LVd{2}[A-Z]{4}[0-9A-Z]{13}$|^LBd{6}[0-9A-Z]{20}$|^LId{7}[0-9A-Z]{12}$|^LTd{18}$|^LUd{5}[0-9A-Z]{13}$|^MKd{5}[0-9A-Z]{10}d{2}$|^MTd{2}[A-Z]{4}d{5}[0-9A-Z]{18}$|^MR13d{23}$|^MUd{2}[A-Z]{4}d{19}[A-Z]{3}$|^MCd{12}[0-9A-Z]{11}d{2}$|^MEd{20}$|^NLd{2}[A-Z]{4}d{10}$|^NOd{13}$|^PLd{10}[0-9A-Z]{,16}n$|^PTd{23}$|^ROd{2}[A-Z]{4}[0-9A-Z]{16}$|^SMd{2}[A-Z]d{10}[0-9A-Z]{12}$|^SAd{4}[0-9A-Z]{18}$|^RSd{20}$|^SKd{22}$|^SId{17}$|^ESd{22}$|^SEd{22}$|^CHd{7}[0-9A-Z]{12}$|^TN59d{20}$|^TRd{7}[0-9A-Z]{17}$|^AEd{21}$|^GBd{2}[A-Z]{4}d{14}$"
            },
            {
              "id": "VALID_IBAN",
              "message": "Please enter valid IBAN.",
              "options": [
                "IBAN1",
                "IBAN2",
                "IBAN3"
              ]
            }
          ]
        }
      ]
    }