ISO8583 JS

ISO 8583 is an international standard for financial transaction card originated interchange messaging. It is the International Organization for Standardization standard for systems that exchange electronic transactions initiated by cardholders using payment cards.

This library help you for wrapping message into ISO8583 and parse the message

Installation

npm install iso8583-js

Features

• Wrapping message into ISO8583
• Parse the message

Usage

Example :

let x = new ISO8583({
  header: 'ISO015000017'
});

// Init the structure
x.init([
  ['PRIMARY_ACCOUNT_NUMBER', { bitmap: 2, length: 18 }],
  ['LOCAL_DATE', { bitmap: 13, length: 4 }]
]);

// Set the value
x.set('PRIMARY_ACCOUNT_NUMBER', '366577921569117691');
x.set('LOCAL_DATE', '112406');

// Wrap the message
console.log(x.wrapMsg()); // -> 4008000000000000366577921569117691112406

// Unwrap the message
console.log(x.unWrapMsg('4008000000000000366577921569117691112406'));

API Reference

Initialize new ISO8583

const ISO8583 = require('iso8583-js');

Constructor

const merchant = new ISO8583([options]);

Options

• header : Set the message header if exist
• mti : The message type indicator is a four-digit numeric field which indicates the overall function of the message. This option will read the incoming message of first four-digit as mti. Default : true . See the usage
• elementName : Set the value using elementName. Default: false

Init (Optional)

Initialization of ISO8583 structure.

merchant.init([[key, options]]);

Options

Currently, these options are mandatory

• bitmap : Bitmap for referencing a key
• length : Length of message

Example

merchant.init([
  ['PRIMARY_ACCOUNT_NUMBER', { bitmap: 2, length: 18 }],
  ['LOCAL_DATE', { bitmap: 13, length: 4 }]
]);

set

Set the value by referencing to your key

merchant.set(key, value);

WrapMsg

Wrapping message into ISO8583

merchant.wrapMsg(mtiType); //string

mtiType - optional

You can set the value of MTI Type. For example :

/**
 * - 0800 : Echo 
 * For more, please refer to https://en.wikipedia.org/wiki/ISO_8583 
*/
merchant.wrapMsg(0800);

unWrapMsg

Unwrapping the message and returning as Map structure

let X = merchant.unWrapMsg(hex); //Map [[key, value]]
X.get(key);

console.log(X);

To-Do (Currently not supported yet)

• ~~Initialization should being optional~~ f17ab58
• Bitmap on init method should ordered by ascending
• ~~Checking set key when key not listed on init~~ d8266ee
• Add options output as (Object or Map) in unWrap method
• ~~Add MTI meaning in wrap message~~ a1bc50c
• Optional to extends the data length. Example use case for bitmap 43, 48, etc
• Attributes enhancement
• Better documentation

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!