JSPM

sepa-qr

0.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 41
  • Score
    100M100P100Q62910F
  • License MIT

Generate QR codes for SEPA payments

Package Exports

  • sepa-qr

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sepa-qr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

sepa-qr-js

Generates SEPA QR codes based on the European Payments Council's standard. These QR codes are scannable by many mobile banking apps.

Uses qr-image and forwards options for lower level QR manipulation.

The goal is to get this on par with sepa-qr-php, which should be quite feature-complete and tested (PRs appreciated).

Installation

npm install sepa-qr

Usage

const createSepaQr = require('sepa-qr');
const {createWriteStream} = require('fs');

createSepaQr({
  name: 'Name of the beneficiary',
  iban: 'BE123456789123456789',
  amount: 100, // in Euro
  remittance: 'Invoice 123456789'
}).pipe(createWriteStream('sepa.png'));

Options

The options below relate to the SEPA standard. All other options are forwarded to qr-image (except for ec_level which is always M).

serviceTag (default: 'BCD')

version (default: '002')

characterSet (default: createSepaQr.UTF_8)

identification (default: 'SCT')

bic (default: '')

name (default: '')

iban

amount (default: 0.01)

purpose (default: '')

remittance (default: '')

information (default: '')