README

IBAN

With this package you will be able to validate IBAN numbers and get BIC information.

Installation

Install the package via Composer:

composer require marshmallow/iban

The package requires PHP ^7.0|^8.0. Everything is exposed through static methods, so there is nothing to register or configure.

Usage

The package exposes a single class, Marshmallow\IBAN\IBAN, with three static methods.

Validate an IBAN

Call Marshmallow\IBAN\IBAN::validate($iban) to check whether the provided IBAN is valid. Returns true or false. Spaces are ignored, so both spaced and unspaced IBANs are accepted.

use Marshmallow\IBAN\IBAN;

IBAN::validate('NL93 RABO 0317 7456 46'); // true
IBAN::validate('NL00RABO0000000000');     // false

Get the bank account number

Call Marshmallow\IBAN\IBAN::getBankAccount($iban) to get the bank account number. Returns the account number as a string, or null when the IBAN is not valid.

use Marshmallow\IBAN\IBAN;

IBAN::getBankAccount('NL93RABO0317745646'); // "317745646"

Get the BIC from an IBAN

Call Marshmallow\IBAN\IBAN::getBic($iban) to look up the BIC information for an IBAN. Returns an array when a match is found, or null when the IBAN is invalid or no match exists.

use Marshmallow\IBAN\IBAN;

IBAN::getBic('NL93RABO0317745646');

[
    "bic"            => "RABONL2U",
    "identifier"     => "RABO",
    "name"           => "RABOBANK",
    "iban"           => "NL93RABO0317745646",
    "account_number" => "317745646",
]

Tests during development

When the package is installed as a path dependency inside a host application, you can run its tests with:

php artisan test packages/marshmallow/iban

Security Vulnerabilities

Please report security vulnerabilities by email to stef@marshmallow.dev rather than via the public issue tracker.

Credits

• Stef
• All Contributors

License

The MIT License (MIT).