Important

Introducing ISO20022 Pro, the Web-App layer of ISO20022 - create and import ISO20022 files in a single UI.

Check it out at https://iso20022pro.com.

iso20022.js

This package is meant for companies using ISO20022 to send and receive payment information, specifically initiating payments and receiving cash management files.

Read the Docs: https://docs.iso20022js.com

The mission of this NPM package is to connect the most widely used programming language to the most widely used payment standard.

If you're interested in using iso20022.js and would like to use different payment types or ingest files using CAMT, please email iso20022js@woodside.sh.

Installation

npm install iso20022.js

Usage

Payment Initiation: Sending a SWIFT Transfer

import { ISO20022 } from 'iso20022.js';

const iso20022 = new ISO20022({
  initiatingParty: {
    name: 'Acme Corporation',
    id: 'ACMECORP',
    account: {
      accountNumber: '123456789012',
    },
    agent: {
      bic: 'CHASUS33',
      bankAddress: {
        country: 'US',
      },
    },
  },
});

const creditPaymentInitiation = iso20022.createSWIFTCreditPaymentInitiation({
  paymentInstructions: [
    {
      type: 'swift',
      direction: 'credit',
      amount: 1000,
      currency: 'USD',
      creditor: {
        name: 'Jane Smith',
        account: {
          iban: 'DE89370400440532013000',
        },
        agent: {
          bic: 'DEUTDEFF',
        },
        address: {
          streetName: '123 Main St',
          townName: 'Funkytown',
          postalCode: '12345',
          country: 'DE',
        },
      },
    },
  ],
});

console.log(creditPaymentInitiation.toString());

Cash Management: Ingesting a CAMT.053 file

import { CashManagementEndOfDayReport } from 'iso20022.js';

const xml = fs.readFileSync('balance_report.xml', 'utf8');
const report = CashManagementEndOfDayReport.fromXML(xml);

console.log(report.transactions);

About ISO20022

ISO20022 is the standard format for financial transactions. This library aims to build a powerful yet simple API to create these files, following Typescript conventions.

You might want to use this package if you need to create these types of files.

Features

Feature	Description	Todo
SWIFT Credit Transfer	Create SWIFT credit transfer messages	✅
CAMT Transactions	Ingest transaction data from CAMT files	✅
SEPA Credit Transfer	Create SEPA credit transfer messages	✅
Fednow Credit Transfer	Create Fednow credit transfer messages	🚧

Reasons to use iso20022.js

Feature	Description
XML Generation	Generate valid ISO 20022 XML files	✅
Type Safety	Built with TypeScript for enhanced type checking	✅
Extensible	Easy to extend for custom message types	✅
Validation	Built-in validation for ISO 20022 message structures	✅

Security

iso20022.js is local, open source, and free to use. This means that payment instructions are created on your machine, not on a remote server.

We take security seriously, and are consistently looking for ways to improve. If you have any suggestions or find any security issues, please open an issue.

NOTE: We are tracking the libxmljs vulnerability, a dependency we use in our unit tests and have a plan to deprecate. Note that production use of iso20022.js is not affected by this vulnerability.