mt940js is a SWIFT mt940 bank statement format parser for javascript (ES2015). Takes in text of mt940 file, puts out array of parsed statements and transactions. See examples below.
npm install mt940jsMain parser class - Parser - parses input text (e.g. read from a file) into array of statements (a file may contain one or more). Each output statement contains a set of attributes, describing opening balance, statement number, etc and also an array of transactions.
Example
const mt940js = require('mt940js');
const parser = new mt940js.Parser();
const statements = parser.parse(fs.readFileSync('./some_path', 'utf8'));
for (let s of statements) {
console.log(s.number.statement, s.statementDate);
for (let t of s.transactions) {
console.log(t.amount, t.currency);
}
}Statement
transactionReference{string} - tag 20 referencerelatedReference{string} - tag 21 reference, optionalaccountIdentification{string} - tag 25 own bank account identificationnumber.statement{string} - tag 28 main statement numbernumber.sequence{string} - tag 28 statement sub number (sequence), optionalnumber.section{string} - tag 28 statement sub sub number (present on some banks), optionalopeningBalanceDate{Date} - tag 60 statement opening dateclosingBalanceDate{Date} - tag 62 statement closing datestatementDate{Date} - abstraction for statement date =closingBalanceDatecurrency{string} - statement currency (USD, EUR ...)openingBalance{Number} - beginning balance of the statement (with sign, based on debit/credit mark)closingBalance{Number} - ending balance of the statement (with sign, based on debit/credit mark)transactions{array} - collection of transactions
Each Transaction contains data of tag 61 (and tag 86 for details)
date{Date} - transaction dateamount{Number} - transaction amount (with sign, Credit+, Debit-)currency{string} - transaction currency (copy of statement currency)details{string} - content of relevant 86 tag(s), may be multiline (\nseparated)transactionType{string} - MT940 transaction type code (e.g. NTRF ...)reference{string} - payment reference fieldentryDate{Date} - entry date field, optionalfundsCode{string} - funds code field, optionalbankReference{string} - bank reference, optionalextraDetails{string} - extra details, optional
Each statement is validated for:
- all strictly required tags
- opening/closing balance currency is the same
- opening balance + turnover = closing balance
Invocation
The Parser has just one method - parse(data, withTags = false) - which will convernt raw mt940 string to an array of statements described above. The optional withTags param would preserve parsed tags to an additional tags attribute of a statement (for any additional further analyasis).
Support for field 86 structure
Currently the library supports '<sep>DD' structure tag format. E.g.
'>20some details >30more data'
<sep> can be '>' or '?'.
The parser attempts to detect if field 86 contains tags like this and, if yes, adds structuredDetails attribute to a statement line. Tag digits are not interpreted as they are not standartized among different banks.
// let incoming file contain one line with 86 field:
// '>20some details>30more data'
const statements = ... // parsing here
for (let s of statements) {
for (let t of s.transactions) {
console.log(t.structuredDetails);
// { '20': 'some details',
// '30': 'more data' }
}
}Contribution is welcomed :)
- pre/post parsing callbacks
- better support for structured 86 field (e.g /XXX/ tags)
The code is licensed under Apache-2.0 License. Please see LICENSE for details.
Inspired by https://github.com/WoLpH/mt940