Iban
Edit this pageWarning: You are browsing the documentation for Symfony 3.3, which is no longer maintained.
Read the updated version of this page for Symfony 6.2 (the current stable version).
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.
| Applies to | property or method |
| Options | |
| Class | Iban |
| Validator | IbanValidator |
Basic Usage
To use the Iban validator, simply apply it to a property on an object that will contain an International Bank Account Number.
- Annotations
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// src/AppBundle/Entity/Transaction.php
namespace AppBundle\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;
}Available Options
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.
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.
