node-ebics-client

Maintained fork. Combines several open upstream PRs — H005 (EBICS 3.0) order types (H3K key management, HVE view-orders), certificate-based bank letters, H005 bank-key parsing and other fixes — plus a full TypeScript rewrite. Requires Node.js 22+.

Pure Node.js (>= 22) implementation of EBICS (Electronic Banking Internet Communication).

The client is aimed to be 100% ISO 20022 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.

Initialization

1. Create a configuration (see example configs) with the EBICS credentials you received from your bank and name it in this schema: config.<environment>.<bank>[.<entity>].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 pnpm tsx examples/initialize.ts <environment> <bank> [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 pnpm tsx examples/bankLetter.ts <environment> <bank> [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 pnpm tsx examples/save-bank-keys.ts <environment> <bank> [entity]

If all these steps were executed successfully, you can now do all things EBICS, like fetching bank statements by running pnpm tsx examples/send-sta-order.ts <environment> <bank> [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
• Zürcher Kantonalbank
• Raiffeisen Schweiz
• BW Bank
• Bank GPB International S.A.
• Bank GPB AO
• J.P. Morgan

Inspiration

The basic concept of this library was inspired by the EPICS library from the Railslove Team.

Copyright

Copyright: Dimitar Nanov, 2019-2022. Licensed under the MIT license.