CHANGELOG.rst

Changelog

Versions follow CalVer with the scheme YY.0M.Micro.

2025.01.0 - 2025/01/21

Changed

• Update the bank registries for Austria, Germany and Switzerland
• Added some manual entries for France and Great Britain

2024.11.0 - 2024/11/11

Changed

• Removed support for deprecated Python version 3.8
• Updated the bank registries for Austria, Germany, Poland, Netherlands, Spain, Czech Republic, Italy, and Switzerland.

Added

• New French Banks @Natim
• Add modulr bank to Spanish bank registry @jose-reveni

2024.09.0 - 2024/09/31

Fixed

• Fix Python 3.8 support while it is still supported (EOL is 2024-10) (thanks to @bwoodsend)

2024.08.1 - 2024/08/13

Added

• Allow BIC and IBAN objects to be deepcopied (thanks to @binaryDiv for pointing this out).

2024.08.0 - 2024/08/13

Added

• Added French Polynesian banks to the registry @tut-tuuut
• Added bnext to the Spanish registry @jose-reveni

Changed

• Extended the Danish bank registry including many more banks now.
• Updated the Belgian bank registry @sennbos
• Updated bank registries for Austria, Germany, Poland, Czech Republic, Switzerland, Italy, Norway and Netherlands.

2024.06.1 - 2024/06/10

Fixed

• The BIC.from_bank_code now handles banks correctly that have no value for the BIC field in the registry.

Changed

• Use hatch fmt and hatch test commands for internal development.

2024.06.0 - 2024/06/04

Changed

• Stop using the "elfprooef" algorithm when validating Dutch IBANs, since the administrative authority says it should not be checked any more.

2024.05.4 - 2024/05/25

Added

• The IBAN and BBAN classes now have an additional property currency_code for countries like Seychelles, Guatemala or Mauritius.

Fixed

• Also allow the BIC lookup for non-primary banks. For countries like Switzerland the lookup did fail for banks which did not have the primary-flag set, even though an appropriate mapping was available.
• IBAN.random() now also works for countries which have a currency code included in their BBAN e.g. Mauritius or Seychelles.
• IBAN.random() now also works for aspirational countries, where no information of the BBAN structure is available, e.g. Comoros.

2024.05.3 - 2024/05/10

Added

• There is a new classmethod IBAN.random() that allows you to create random, but valid IBANs.

  >>> IBAN.random()
  <IBAN=LT435012771675726758>

  You can narrow down the generated values by providing the corresponding parameters to this function. E.g. to get only Spanish IBANs you can do

  >>> IBAN.random(country_code="ES")
  <IBAN=ES8801253179194914182449>

Changed

• Some missing bank associations have been added to the Portoguese bank registry by @tiagoafseixas

2024.05.2 - 2024/05/09

Fixed

• Add typing-extensions as explicit dependency for Python < 3.11 to support the Self type.

2024.05.1 - 2024/05/09

Changed

• Remove custom collection logic of the bank registry for pyinstaller. The changes introduced in #92 were wrong and have been reverted. Usage example

  $ pyinstaller <script> --collect-data schwifty --copy-metadata schwifty

2024.05.0 - 2024/05/07

Fixed

• Loading JSON data into a Pydantic model with an IBAN or BIC-field (Model.model_validate_json()) was previously broken and has been fixed now.

Added

• JSON schema generation for Pydantic models.

Changed

• Updated bank registries.
• Remove the dependency to iso3166 since its functionallity is already covered by pycountry

2024.04.0 - 2024/04/18

Added

• Added Revolut Bank for Spain @brunovilla
• Added support for Python 3.12
• Added manually curated bank registry for Montenegro @Djuka

Changed

• The bank registry is now internally validated, so that all domestic bank codes actaully match the specification of the corresponding BBAN structure. As a result some entries had to be removed, because they did contain invalid bank codes.
• The Danish national checksum algorithm is considered opaque and the checksum digit is assumed to be part of the account number (which is now always 10 digits long).

Fixed

• The Czech bank registry was stored in latin-1 encoding while being read as UTF-8. This resulted in invalid bank names @Natim and @Cogax.
• The Norwegian national checksum algorithm was rendering wrong results in some edge-cases @Natim

2024.01.1 - 2024/01/05

Added

• Support aspirational countries:
  • Algeria
  • Angola
  • Benin
  • Burkina Faso
  • Burundi
  • Cabo Verde
  • Cameroon
  • Central African Republic
  • Chad
  • Comoros
  • Congo
  • Côte d'Ivoire
  • Djibouti
  • Equatorial Guinea
  • Gabon,
  • Guinea-Bissau
  • Honduras
  • Iran
  • Madagascar
  • Mali
  • Morocco
  • Mozambique
  • Nicaragua
  • Niger
  • Senegal
  • Togo
• National checksum algorithms for many countries have been added:
  • Albania
  • Bosnia and Herzegovina
  • Czech Republic
  • East Timor
  • Estonia
  • Finland
  • Iceland
  • Mauritania
  • Montenegro
  • North Macedonia
  • Norway
  • Poland
  • Portugal
  • Serbia
  • Slovakia
  • Slovenia
  • Spain
  • Tunisia
• Add new banks to the list of French banks @Natim:
  • ARKEA BP Brest
  • Anytime
  • Lydia Bank
  • MEMO BANK
  • Revolut
  • SHINE
  • SumUp Limited
• New :attr:`.IBAN.in_sepa_zone`-property to indicate if the IBAN's country is part of the SEPA zone.
• New manual bank registries for
  • Andorra
  • Arabic Emirates
  • Costa Rica
  • Portugal
• New attributes :attr:`.IBAN.account_id`, :attr:`.IBAN.account_holder_id` and :attr:`.IBAN.account_type` that are available depending on the country's BBAN specification. E.g. :attr:`.IBAN.account_holder_id` is currently only available for Iceland (Kennitala) and only Brazil defines an :attr:`.IBAN.account_id`.

Changed

• Use enhanced IBAN/BBAN format from Wikipedia, since the official information from SWIFT is often inacurate.
• The support for national checksum digits has been reimplemented.
• The :class:`.IBAN`-class now has an additional :attr:`.IBAN.bban`-attribute, where all country specific functionality has been moved to.
• Updated bank registries. Thanks to @sh4dowb for the Turkish banks.

2023.11.2 - 2023/11/27

Added

• Add OKALI to the list of French banks @Natim.

2023.11.1 - 2023/11/27

Changed

• The Swiss bank registry is now generated from the SIX Group.
• Manually add missing bank entry for Spain.
• Updated bank registr for Austria and Poland.

2023.11.0 - 2023/11/17

Changed

• The validation of a :class:`.BIC` is now performed in the context of ISO 9362:2022 which allows numbers in the business party prefix. If strict SWIFT compliance is reqruied the enforce_swift_compliance parameter can be set to True.
• The :meth:`.BIC.from_bank_code`-method will now select the most generic BIC (e.g. with no branch specifier or the "XXX" value) if multiple BICs are associated to the given domestic bank code. @Natim.
• Many manually curated bank registry entries have been re-added by @dennisxtria

2023.10.0 - 2023/10/31

Added

• The Pydantic v2 protocol is now supported, so that the :class:`.IBAN` and :class:`.BIC` classes can be directly used as type annotations in Pydantic models

Changed

• The :class:`.IBAN` and :class:`.BIC` classes are now subclasses of :class:`str` so that all string related methods and functionallities (e.g. slicing) are directly available.

2023.09.0 - 2023/09/25

Removed

• Support for Python 3.7 has been dropped.

Added

• New method :meth:`.BIC.candidates_from_bank_code` to list all matching BICs to a given domestic bank code @Natim.

Changed

• The Italian bank registry is now automatically generated thanks to @Krystofee

Internal

• Switch project tooling to hatch.
• Use ruff instead of [flake8](https://flake8.pycqa.org/en/latest/) as linter.
• Upgrade mypy to 1.5.1 and fix all new typing errors.

2023.06.0 - 2023/06/21

Fixed

• For Ukrainian banks calling iban.bic did result in a TypeError. Thanks @bernoreitsma for reporting.

Changed

• Updated generated bank registries for Austria, Belgium, Czech Republic, Germany, Netherlands, Hungary, Norway, Poland and Ukraine.

2023.03.0 - 2023/03/14

Changed

• Updated generated bank registries for Austria, Belgium, Germany, Netherlands, Hungary, Slovenia and Ukraine.

Added

• New bank registry for Norway thanks to @ezet

2023.02.1 - 2023/02/28

Fixed

• The domestic checksum calculation for Belgium now returns 97 in case the modulo operation results in 0. @mhemeryck

Changed

• Updated generated bank registries for Austria, Belgium, Czech Republic, Germany, Spain, Hungary and Croatia.

2023.02.0 - 2023/02/06

Added

• New banks for Portugal and Italy @dennisxtria
• Added support for Ukrainian banks @shpigunov

Fixed

• Corrected bank codes for Cypriot banks @Krystofee

2022.09.0 - 2022/16/09

Added

• IBAN validation for Senegal mkopec87

Changed

• Refactored most of the scripts to generate the bank registry to use Pandas @pebosi
• Updated bank registry for Austria, Belgium, Germany, Spain, Hungary, Netherlands and Poland.

2022.07.1 - 2022/28/07

Fixed

• In some countries the BBAN does not include a bank code, but only a branch code (e.g. Poland). In those cases the branch code should be used to lookup the bank associated to an IBAN instead of the obviously empty bank code.

2022.07.0 - 2022/07/07

Fixed

• Hungarian bank registry generator script was fixed by @Krystofee

2022.06.3 - 2022/06/29

Added

• Generated list of Lithuanian BICs @Draugelis
• Removed manually curated list of Lithuanian banks.

2022.06.2 - 2022/06/22

Added

• Generated list of Greek BICs @kounabi
• Generated list of Cypriot BICs @kounabi

Changed

• Updated bank registry for Austria, Belgium, Czech Republic, Germany, Croatia, Netherlands, Poland and Slovenia.

Fixed

• The domestic bank code for Hungarian banks was wrongly generated @Krystofee

2022.06.1 - 2022/06/06

Added

• Generated list of Romanian BICs @Krystofee
• Generated list of Hungarian BICs @Krystofee
• Extended manually curated list of Irish BICs @dennisxtria

2022.06.0 - 2022/06/06

Added

• Manually curated list of Bulgarian BICs @Krystofee
• Manually curated list of Saudi Arabian BICs @samizaman
• Support for PyInstaller @Lukasz87

Internal

• Run tests on Python 3.10 @adamchainz
• Use standard keys in setup.cfg @adamchainz
• Don't rely on hacking in test-setup @adamchainz

2022.04.2 - 2022/04/29

Changed

• Allow getting bank names from IBAN. Previously, you could do iban.bic.bank_names[0], but since a BIC can be associated to multiple bank codes the context of the specific bank is lost and you could end up with the wrong bank name. @jose-reveni

2022.04.1 - 2022/04/29

Changed

• The Italian BBAN checksum algorithm is now also applied for San Marino @fabienpe

Fixed

• Fix Italian BBAN checksum calculation #78
• Fix bank code position in BBAN for Jordan banks @fabienpe

2022.04.0 - 2022/04/11

Changed

• Update bank registry for Austria, Czech Republic, Germany, Spain, Poland and Slovakia.

Fixed

• Removed bogus line from dutch bank registry.
• Loading the bank registry now also works on machines that don't have UTF-8 as their default encoding @imad3v

2022.03.1 - 2022/03/05

Added

• Country specifc checksum validation for French banks (based on the work of @sholan)

2022.03.0 - 2022/03/04

Added

• The :class:`.IBAN` and :class:`.BIC` classes now support the __len__ method to allow a more Pythonic calculation of the length.

Changed

• Update bank registry for Czech Republic, Spain, Hungary, Poland and Slovakia.

2022.02.0 - 2022/02/15

Added

• N26 BIC for Spain @brunovila
• Manually curated entries for banks from Iceland @gautinils

Changed

• Removed manually curated bank entries for Spain since all values were already part of the generated registry.
• Updated bank registry for Austria, Belgium, Czech Republic, Germany, Spain, Netherlands and Poland
• Added overwrite for IBAN spec of Czech Republic and France. The branch and account code positions are wrongly provided in the official IBAN registry.

2021.10.2 - 2021/10/12

Added

• Added 440 additional bank records for Spain.

2021.10.1 - 2021/10/11

Changed

• Use importlib.resources for loading internal registries. This removes the need to have setuptools installed. Thank you @a-recknagel for the idea!

Fixed

• Ensure that Belgian BBAN checksums are always 2 digits long.

2021.10.0 - 2021/10/01

Added

• Added IBAN spec for Sudan (SD).
• Added and extended manually curated bank entries for Turkey, Italy, Israel, Ireland, Spain, Switzerland and Denmark @howorkon.

Changed

• Updated bank registry for Austria, Belgium, Czech Republic, Germany, Netherlands, Poland, Slovenia and Slovakia.

Fixed

• Disallow schwifty to be installed for Python versions older than 3.7. It was unsupported before but is now rejected upon installation with an appropriate error message.
• Austrian bank codes are now consistently left padded with zeros. This fixes the mapping from IBAN to BIC for the Austrian federal bank institutes.

2021.06.1 - 2021/06/24

Added

• Enable tool based type checking as described in PEP-0561 by adding the py.typed marker @jmfederico

2021.06.0 - 2021/06/17

Added

• Added bank registry for Swedish Banks @jmfederico

2021.05.2 - 2021/05/23

Added

• Country specifc checksum validation for Belgian banks, as well as support for generating the checksum when using the :meth:`.IBAN.generate`-method. @mhemeryck

2021.05.1 - 2021/05/20

Added

• The IBAN validation now optionally includes the verification of the country specific checksum within the BBAN. This currently works for German and Italian banks. For German banks the checksum algorithm for the account code is chosen by the bank code. Since there are over 150 bank specific algorithms in Germany not all of them are implemented at the moment, but the majority of banks should be covered.

Changed

• Update bank registry for Germany, Poland, Czech Republic, Austria and Netherlands.

2021.05.0 - 2021/05/02

Added

• Added manually curated list of Lithuanian Banks (e.g Revolut Payments UAB).

2021.04.0 - 2021/04/23

Changed

• Added type hints to the entire code base.
• Dropped support for Python 3.6
• Update bank registry for Austria, Poland, Germany, Belgium, Czech Republic, Netherlands, Slovenia and Slovakia.

2021.01.0 - 2021/01/20

Changed

• Restructure documentation and change theme to furo.
• Added dedicated exception classes for various validation errors.
• Drop support for Python 2. Only Python 3.6+ will be supported from now on.
• Use PEP 517/518 compliant build setup.

2020.11.0 - 2020/12/02

Changed

• Updated IBAN registry and bank registries of Poland, Germany, Austria, Belgium, Netherlands, Czech Republic and Slovenia.

Added

• Added generated banks for Slovakia @petrboros.
• Added a test to validate the correctnes of BICs in the registry @ckoehn.

Fixed

• Fixed encoding for Polish bank registry @michal-michalak.

2020.09.0 - 2020/09/07

Changed

• Migrated build and test pipelines to GitHub actions.

Added

• Added generated banks for Netherlands @insensitiveclod.
• Added generated banks for Spain.

2020.08.3 - 2020/08/31

Fixed

• Fixed IBAN generation for countries with branch/sort code
• Add generated banks for Spain

2020.08.2 - 2020/08/30

Fixed

• Poland's IBAN spec only has a branch-code but no bank-code
• Fixed listing of supported countries for BIC derivation.
• Fixed bank registry for Hungary.

Changed

• Updated bank registry Poland, Belgium and Austria.
• Updated IBAN spec for Sao Tome and Principe

2020.08.1 - 2020/08/28

Added

• New attribute :attr:`.BIC.is_valid` and :attr:`.IBAN.is_valid`.

2020.08.0 - 2020/08/06

Changed

• Updated bank registry for Poland.

2020.05.3 - 2020/05/25

Added

• Added banks for France, Switzerland and Great Britain.

2020.05.2 - 2020/05/08

Added

• Added :attr:`.BIC.country` and :attr:`.IBAN.country`.