IBAN

IBAN

This constraint is used to ensure that a bank account number has the proper format of an International Bank Account Number (IBAN). IBAN is an internationally agreed means of identifying bank accounts across national borders with a reduced risk of propagating transcription errors.

Basic Usage

To use the IBAN validator, apply it to a property on an object that will contain an International Bank Account Number.

• Annotations

  // src/Entity/Transaction.php
  namespace App\Entity;
  use Symfony\Component\Validator\Constraints as Assert;
  class Transaction
  {
      /**
       * @Assert\Iban(
       *     message="This is not a valid International Bank Account Number (IBAN)."
       * )
       */
      protected $bankAccountNumber;
  }

• YAML

  # config/validator/validation.yaml
  App\Entity\Transaction:
      properties:
          bankAccountNumber:
              - Iban:
                  message: This is not a valid International Bank Account Number (IBAN).

• XML

  <!-- config/validator/validation.xml -->
  <?xml version="1.0" encoding="UTF-8" ?>
  <constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">
      <class name="App\Entity\Transaction">
          <property name="bankAccountNumber">
              <constraint name="Iban">
                  <option name="message">
                      This is not a valid International Bank Account Number (IBAN).
                  </option>
              </constraint>
          </property>
      </class>
  </constraint-mapping>

• PHP

  // src/Entity/Transaction.php
  namespace App\Entity;
  use Symfony\Component\Validator\Constraints as Assert;
  use Symfony\Component\Validator\Mapping\ClassMetadata;
  class Transaction
  {
      protected $bankAccountNumber;
      public static function loadValidatorMetadata(ClassMetadata $metadata)
      {
          $metadata->addPropertyConstraint('bankAccountNumber', new Assert\Iban([
              'message' => 'This is not a valid International Bank Account Number (IBAN).',
          ]));
      }
  }

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

groups

type: array | string

It defines the validation group or groups this constraint belongs to. Read more about validation groups.

message

type: string default: This is not a valid International Bank Account Number (IBAN).

The default message supplied when the value does not pass the IBAN check.

You can use the following parameters in this message:

payload

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.