The openiban API will cease operation on the 24th of May, 10 p.m. GMT.
You can read more about it at https://openiban.com.
Important: I will continue to maintain the goiban-service
repository.
Official openiban.com API client for node and the browser. TypeScript typings are included in the repository.
You can install openiban.js through npm or yarn.
npm i -S openiban
or
yarn add openiban
Or you can include it on your page through a CDN (e.g. unpkg):
<script type="text/javascript" src="//unpkg.com/[email protected]/dist/openiban.browser.js"></script>
openiban.js provides a Promise API to the openiban.com IBAN validation webservice.
const Openiban = require('openiban');
openiban
.validate('DE89370400440532013000')
.then((result) => {
// result.valid should be true
})
.catch((err) => {
// some http error has occurred
});
openiban.js also publishes Typescript declarations.
import * as Openiban from 'openiban';
Openiban.validate('DE89370400440532013000')
.then((r: ValidationResult) => {
console.log(r);
// {
// "valid": true,
// "messages": [
// "Bank code valid: 37040044"
// ],
// "iban": "DE89370400440532013000",
// "bankData": {
// "bankCode": "37040044",
// "name": "Commerzbank",
// "zip": "50447",
// "city": "Köln",
// "bic": "COBADEFFXXX"
// },
// "checkResults": {
// "bankCode": true
// }
// }
})
.catch((e) => {
// some http error has occurred
console.error(e);
})
When openiban.js
is loaded inside your browser, it will be available through the global variable Openiban
.
<html>
<head>
<script type="text/javascript" src="//unpkg.com/[email protected]/dist/openiban.browser.js"></script>
</head>
<body>
<!-- ... -->
<script type="text/javascript">
Openiban
.validate('DE89370400440532013000')
.then((result) => {
// result.valid should be true
})
.catch((err) => {
// some http error has occurred
});
</script>
</body>
</html>