Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marcwrobel/jbanking

A Java banking API
https://github.com/marcwrobel/jbanking

banking business-calendar countries creditor-identifier currencies eea efta eu fed iso-13616 iso-3166-1 iso-4217 iso-9362 java nyse sepa target

Last synced: 3 days ago
JSON representation

A Java banking API

Host: GitHub
URL: https://github.com/marcwrobel/jbanking
Owner: marcwrobel
License: apache-2.0
Created: 2013-05-20T09:29:52.000Z (over 11 years ago)
Default Branch: main
Last Pushed: 2024-10-09T15:40:07.000Z (about 1 month ago)
Last Synced: 2024-10-12T02:45:08.051Z (about 1 month ago)
Topics: banking, business-calendar, countries, creditor-identifier, currencies, eea, efta, eu, fed, iso-13616, iso-3166-1, iso-4217, iso-9362, java, nyse, sepa, target
Language: Java
Homepage:
Size: 992 KB
Stars: 110
Watchers: 8
Forks: 55
Open Issues: 20
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md

Awesome Lists containing this project

README

        [![Open in Gitpod](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/marcwrobel/jbanking/)

[![Build](https://github.com/marcwrobel/jbanking/workflows/build/badge.svg)](https://github.com/marcwrobel/jbanking/actions)

[![Supported JVM Versions](https://img.shields.io/badge/JVM-8--21-brightgreen.svg?logo=openjdk)](https://github.com/marcwrobel/jbanking/actions/workflows/build.yml)

[![Sonarcloud Status](https://sonarcloud.io/api/project_badges/measure?project=fr.marcwrobel:jbanking&metric=alert_status)](https://sonarcloud.io/dashboard?id=fr.marcwrobel:jbanking)

[![SonarCloud Coverage](https://sonarcloud.io/api/project_badges/measure?project=fr.marcwrobel:jbanking&metric=coverage)](https://sonarcloud.io/dashboard?id=fr.marcwrobel:jbanking)

[![SonarCloud Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=fr.marcwrobel:jbanking&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=fr.marcwrobel:jbanking)

[![SonarCloud Bugs](https://sonarcloud.io/api/project_badges/measure?project=fr.marcwrobel:jbanking&metric=bugs)](https://sonarcloud.io/dashboard?id=fr.marcwrobel:jbanking)

[![Maven Central](https://img.shields.io/maven-central/v/fr.marcwrobel/jbanking.svg?logo=apache-maven&label=Maven%20Central)](https://central.sonatype.com/artifact/fr.marcwrobel/jbanking)

[![javadoc](https://javadoc.io/badge2/fr.marcwrobel/jbanking/javadoc.svg)](https://javadoc.io/doc/fr.marcwrobel/jbanking)

[![Reproducible Builds](https://img.shields.io/badge/Reproducible_Builds-ok-success)](https://github.com/jvm-repo-rebuild/reproducible-central#fr.marcwrobel:jbanking)

[![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6217/badge)](https://bestpractices.coreinfrastructure.org/projects/6217)

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/marcwrobel/jbanking/badge)](https://deps.dev/maven/fr.marcwrobel%3Ajbanking)

# jbanking - A Java banking API

jbanking is a library of utilities to assist with developing banking functionalities. jbanking is focused on, but not

limited to, European banking.

## Features

jbanking is supporting the following features :

* [ISO 3166-1 countries](https://wikipedia.org/wiki/ISO_3166-1) with alpha-2 code, alpha-3 code, numeric code and

  status, e.g. independent or dependent (according to the

  [International Organization for Standardization](https://www.iso.org)).

* Countries or territories participation to economic agreements :

  * [European Economic Area (EEA)](https://wikipedia.org/wiki/European_Economic_Area),

  * [European Free Trade Association (EFTA)](https://wikipedia.org/wiki/European_Free_Trade_Association),

  * [European Union (EU)](https://en.wikipedia.org/wiki/European_Union),

  * [SEPA COM Pacifique](https://www.cfonb.org/Default.aspx?lid=1&rid=122&rvid=239),

  * [Single Euro Payments Area (SEPA)](https://wikipedia.org/wiki/Single_Euro_Payments_Area).

* [ISO 4217 currencies](https://wikipedia.org/wiki/ISO_4217) (with alphabetic code, numeric code, minor unit and

  countries using it).

* [ISO 9362 BIC](https://wikipedia.org/wiki/Bank_Identifier_Code) handling and validation.

* [ISO 13616 IBAN](https://wikipedia.org/wiki/International_Bank_Account_Number) handling and validation (for both

  check digit and national bank account number structure).

* Random [ISO 9362 BIC](https://wikipedia.org/wiki/Bank_Identifier_Code) and

  [ISO 13616 IBAN](https://wikipedia.org/wiki/International_Bank_Account_Number) generation.

* [Creditor Identifiers (CIs)](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/creditor-identifier-overview)

  handling and validation.

* Configurable [holiday](https://wikipedia.org/wiki/Holiday) calendar support with predefined calendars for :

  * Frankfurt, London, Paris, Sydney, and Tokyo financial districts,

  * Federal Reserve Bank of New York (FED),

  * New York Stock Exchange (NYSE),

  * European Union TARGET system.

## Requirements

jbanking requires at least [Java 8](https://adoptium.net/) (build is tested against Java 8, 11, 17 and 21). It has no

additional dependency !

## Use it !

You can download the latest build on [Maven Central](https://search.maven.org/artifact/fr.marcwrobel/jbanking) or use it

as a maven dependency:

```xml

  fr.marcwrobel

  jbanking

  4.2.0

```

Then you just have to use the jbanking API.

```java

// Get ISO country information

IsoCountry country = IsoCountry.fromAlpha2Code(" fr ").get();

Assertion.assertEquals("FRA", country.getAlpha3Code());

Assertion.assertEquals(250, country.getNumericCode());

Assertion.assertTrue(country.isIndependent());

Assertion.assertTrue(country.isParticipatingTo(EUROPEAN_ECONOMIC_AREA));

// Get ISO currency information

IsoCurrency currency = IsoCurrency.fromAlphabeticCode(" eur ").get();

Assertion.assertEquals(978, currency.getNumericCode());

Assertion.assertEquals(2, currency.getMinorUnit().get());

Assertion.assertEquals(NATIONAL, currency.getCategory());

Assertion.assertTrue(currency.getCountries().contains(FR));

// Validate an IBAN

Assertions.assertTrue(Iban.isValid(" fr2531682128768051490609537 "));

// Get IBAN information

Iban iban = new Iban(" fr2531682128768051490609537 ");

Assertions.assertEquals("FR2531682128768051490609537", iban.toString());

Assertions.assertEquals("FR25 3168 2128 7680 5149 0609 537", iban.toPrintableString());

Assertions.assertEquals("FR", iban.getCountryCode());

Assertions.assertEquals("25", iban.getCheckDigit());

Assertions.assertEquals("31682128768051490609537", iban.getBban());

Assertions.assertEquals("31682", iban.getBankIdentifier());

Assertions.assertEquals("12876", iban.getBranchIdentifier().get());

Assertions.assertEquals("80514906095", iban.getAccountNumber());

Assertions.assertEquals("37", iban.getNationalCheckDigit().get());

// Generate a random IBAN

Iban randomIban = new RandomIban().next();

// Validate a BIC

Assertions.assertTrue(Bic.isValid(" psstfrppxxx "));

// Get BIC information

Bic bic = new Bic(" psstfrppxxx ");

Assertions.assertEquals("PSSTFRPPXXX", bic.toString());

Assertions.assertEquals("PSST", bic.getInstitutionCode());

Assertions.assertEquals("FR", bic.getCountryCode());

Assertions.assertEquals("PP", bic.getLocationCode());

Assertions.assertEquals("XXX", bic.getBranchCode());

Assertions.assertTrue(bic.isLiveBic());

// Generate a random BIC

Bic randomBic = new RandomBic().next();

// Validate a creditor identifier

Assertions.assertTrue(CreditorIdentifier.isValid(" fr72zzz123456 "));

// Get creditor identifier information

CreditorIdentifier ci = new CreditorIdentifier(" fr72zzz123456 ");

Assertions.assertEquals("FR72ZZZ123456", ci.toString());

Assertions.assertEquals("FR", ci.getCountryCode());

Assertions.assertEquals("72", ci.getCheckDigit());

Assertions.assertEquals("ZZZ", ci.getBusinessCode());

Assertions.assertEquals("123456", ci.getNationalIdentifier());

// Using predefined calendars

Calendar calendar = FinancialCalendars.PARIS;

Assertion.assertTrue(calendar.isHoliday(LocalDate.of(2022, 1, 1)));

Assertion.assertFalse(calendar.isBusinessDay(LocalDate.of(2022, 1, 1)));

Assertion.assertEquals(LocalDate.of(2022, 1, 3), calendar.next(LocalDate.of(2022, 1, 1)));

Assertion.assertEquals(Arrays.asList(LocalDate.of(2022, 1, 3), LocalDate.of(2022, 1, 4)), calendar.businessDaysWithin(LocalDate.of(2022, 1, 1), LocalDate.of(2022, 1, 4)));

```

For more information take a look at [the javadoc](https://javadoc.io/doc/fr.marcwrobel/jbanking) and

[the unit tests](/src/test/java/fr/marcwrobel/jbanking). Changelogs are available on

[GitHub Releases](https://github.com/marcwrobel/jbanking/releases).

## Alternatives

There is no alternatives to jbanking that has all its features. But here are some _partial_ alternatives :

- Java itself for [ISO 3166 countries](https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html)

  and [ISO 4217 currencies](https://docs.oracle.com/javase/8/docs/api/java/util/Currency.html).

- [OpenGamma Strata](https://github.com/OpenGamma/Strata), an open source analytics and market risk library from

  OpenGamma (especially [strata-basics](https://github.com/OpenGamma/Strata/tree/main/modules/basics)).

- [TakahikoKawasaki/nv-i18n](https://github.com/TakahikoKawasaki/nv-i18n), a package to support internationalization,

  containing ISO 3166-1 country code enum, ISO 639-1 language code enum, etc.

- [arturmkrtchyan/iban4j](https://github.com/arturmkrtchyan/iban4j) (or its fork

  [NaluKit/iban4g](https://github.com/NaluKit/iban4g)), a java library for generating and validating IBANs and BICs.

- [Apache Commons Validator](https://commons.apache.org/proper/commons-validator/), a java library for validating a lot

  of things, including IBANs.

## Contribute

Take a look at the [contribution guide](CONTRIBUTING.md).

## Need help ?

Start a [discussion](https://github.com/marcwrobel/jbanking/discussions),

raise an [issue](https://github.com/marcwrobel/jbanking/issues?sort=created&direction=desc&state=open)

or contribute with [a pull-request](https://github.com/marcwrobel/jbanking/pulls) (please take a look at the

[contribution guide](CONTRIBUTING.md) before).

And for the things that must be kept private (**only** !), such as [security issues](/SECURITY.md), email me at

[[email protected]](mailto:[email protected]).