https://github.com/node-ebics/node-ebics-client
Node.js EBICS Client - compliant with ISO 20022
https://github.com/node-ebics/node-ebics-client
accounting bank ebics iso20022 nodejs
Last synced: 3 days ago
JSON representation
Node.js EBICS Client - compliant with ISO 20022
- Host: GitHub
- URL: https://github.com/node-ebics/node-ebics-client
- Owner: node-ebics
- License: mit
- Created: 2018-05-17T14:26:41.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2025-04-02T23:35:22.000Z (over 1 year ago)
- Last Synced: 2025-10-23T22:49:36.098Z (9 months ago)
- Topics: accounting, bank, ebics, iso20022, nodejs
- Language: JavaScript
- Homepage:
- Size: 517 KB
- Stars: 79
- Watchers: 6
- Forks: 35
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-europe - node-ebics-client - ebics/node-ebics-client?style=flat-square&label=⭐)](https://github.com/node-ebics/node-ebics-client/stargazers) [](https://github.com/node-ebics/node-ebics-client/commits/master) [](https://github.com/node-ebics/node-ebics-client) [](https://github.com/node-ebics/node-ebics-client/blob/master/LICENSE) [](https://www.ebics.org/) [](https://www.iso20022.org/) [](https://eur-lex.europa.eu/eli/dir/2015/2366/oj) - Node.js EBICS client compliant with ISO 20022 for European electronic banking. (Payments and Banking)
README
node-ebics-client
Pure Node.js (>= 16) implementation of [EBICS](https://en.wikipedia.org/wiki/Electronic_Banking_Internet_Communication_Standard) (Electronic Banking Internet Communication).
The client is aimed to be 100% [ISO 20022](https://www.iso20022.org) compliant, and supports the complete initializations process (INI, HIA, HPB orders) and HTML letter generation.
## Usage
For examples on how to use this library, take a look at the [examples](https://github.com/node-ebics/node-ebics-client/tree/master/examples).
### A note on recent Node.js versions
The latest Node.js versions don't support `RSA_PKCS1_PADDING` for private decryption for security reasons, throwing an error like _TypeError: RSA_PKCS1_PADDING is no longer supported for private decryption, this can be reverted with --security-revert=CVE-2023-46809_.
EBICS requires this mode, so in order for this library to work, add the following parameter when starting Node.js: `--security-revert=CVE-2023-46809`
### Initialization
1. Create a configuration (see [example configs](https://github.com/node-ebics/node-ebics-client/tree/master/examples/config)) with the EBICS credentials you received from your bank and name it in this schema: `config..[.].json` (the entity is optional).
- The fields `url`, `partnerId`, `userId`, `hostId` are provided by your bank.
- The `passphrase` is used to encrypt the keys file, which will be stored at the `storageLocation`.
- The `bankName` and `bankShortName` are used internally for creating files and identifying the bank to you.
- The `languageCode` is used when creating the Initialization Letter and can be either `de`, `en`, or `fr`.
- You can chose any environment, bank and, optionally, entity name. Entities are useful if you have multiple EBICS users for the same bank account.
2. Run `node examples/initialize.js [entity]` to generate your key pair and perform the INI and HIA orders (ie. send the public keys to your bank)
The generated keys are stored in the file specified in your config and encrypted with the specified passphrase.
3. Run `node examples/bankLetter.js [entity]` to generate the Initialization Letter
4. Print the letter, sign it and send it to your bank. Wait for them to activate your EBICS account.
5. Download the bank keys by running `node examples/save-bank-keys.js [entity]`
If all these steps were executed successfully, you can now do all things EBICS, like fetching bank statements by running `node examples/send-sta-order.js [entity]`, or actually use this library in your custom banking applications.
## Supported Banks
The client is currently tested and verified to work with the following banks:
- [Credit Suisse (Schweiz) AG](https://www.credit-suisse.com/ch/en.html)
- [Zürcher Kantonalbank](https://www.zkb.ch/en/lg/ew.html)
- [Raiffeisen Schweiz](https://www.raiffeisen.ch/rch/de.html)
- [BW Bank](https://www.bw-bank.de/de/home.html)
- [Bank GPB International S.A.](https://gazprombank.lu/e-banking)
- [Bank GPB AO](https://gazprombank.ru/)
- [J.P. Morgan](https://www.jpmorgan.com/)
## Inspiration
The basic concept of this library was inspired by the [EPICS](https://github.com/railslove/epics) library from the Railslove Team.
## Copyright
Copyright: Dimitar Nanov, 2019-2022.
Licensed under the [MIT](LICENSE) license.