Data types for accounts in the swedish banking system, Handelsbanken, ICA-banken, Nordea, SEB, Skandiabanken, Swedbank, PlusGirot, Bankgirot among others

composer require byrokrat/banking

use byrokrat\banking\AccountFactory;
use byrokrat\banking\BankNames;

$factory = new AccountFactory;
$account = $factory->createAccount('3300,1111111116');

echo $account->getBankName();                      // Nordea
$account->getBankName() == BankNames::BANK_NORDEA; // true
echo $account->getClearingNumber();                // 3300
echo $account->getSerialNumber();                  // 111111111
echo $account->getCheckDigit();                    // 6
echo $account->getNumber();                        // 3300,111 111 111-6
echo $account->get16();                            // 3300001111111116

See the list of bank and format identifiers.

Account numbers implement the AccountNumber interface. AccountNumber defines the following api:

When processing a raw account number the following rules apply:

1. Spaces are ignored.
2. An optional , delimiter between clearing and serial numbers may be used.
3. An optional - delimiter may be used before check digits.

The following formats are all valid (and considered equal)

14053542562
1405,3542562
1405,354256-2
1405,354 256-2

Swedbank account numbers with clearing numbers starting with 8 may specify a fifth clearing number check digit. The clearing number check digit is optional, but if present a , must be used to mark where the clearing number ends and the serial number begins.

The following formats are valid (and equal)

81050,744202466
8105-0,744202466

NOTE: When parsing Bankgiro or PlusGiro account numbers without delimiters always whitelist the expected format before parsing.

The - delimiter is optional when parsing Bankgiro and PlusGiro account numbers. When omitted it may not be possible determine if the raw number is indeed a Bankgiro or PlusGiro account number: 5805-6201 is a valid Bankgiro number and 5805620-1 is a valid PlusGiro number.

This issue is resolved by whitelisting the expected format prior to parsing.

use byrokrat\banking\AccountFactory;
use byrokrat\banking\BankNames;

$factory = new AccountFactory;
$factory->whitelistFormats([BankNames::FORMAT_PLUSGIRO]);
$account = $factory->createAccount('58056201');
$account->getBankName() == BankNames::BANK_PLUSGIRO;      // true

use byrokrat\banking\AccountFactory;
use byrokrat\banking\BankNames;

$factory = new AccountFactory;
$factory->whitelistFormats([BankNames::FORMAT_BANKGIRO]);
$account = $factory->createAccount('58056201');
$account->getBankName() == BankNames::BANK_BANKGIRO;      // true

Banking is covered under the WTFPL

@author Hannes Forsgård (hannes.forsgard@fripost.org)