https://github.com/derhuerst/sepa-payment-qr-code

Generate a QR code to initiate a SEPA bank transfer.
https://github.com/derhuerst/sepa-payment-qr-code

bank payment qr-code sct sepa

Last synced: 5 days ago
JSON representation

Generate a QR code to initiate a SEPA bank transfer.

• Host: GitHub
• URL: https://github.com/derhuerst/sepa-payment-qr-code
• Owner: derhuerst
• License: isc
• Created: 2019-01-28T13:24:01.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-06T22:42:52.000Z (8 months ago)
• Last Synced: 2024-10-03T23:55:43.862Z (about 1 month ago)
• Topics: bank, payment, qr-code, sct, sepa
• Language: JavaScript
• Homepage: https://github.com/derhuerst/sepa-payment-qr-code#sepa-payment-qr-code
• Size: 36.1 KB
• Stars: 31
• Watchers: 3
• Forks: 7
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: license.md

Awesome Lists containing this project

README

        
# sepa-payment-qr-code

**Generate a [QR code to initiate a SEPA credit transfer](https://en.wikipedia.org/wiki/EPC_QR_code)** a.k.a. bank transfer.

[![npm version](https://img.shields.io/npm/v/sepa-payment-qr-code.svg)](https://www.npmjs.com/package/sepa-payment-qr-code)

![ISC-licensed](https://img.shields.io/github/license/derhuerst/sepa-payment-qr-code.svg)

[![support me via GitHub Sponsors](https://img.shields.io/badge/support%20me-donate-fa7664.svg)](https://github.com/sponsors/derhuerst)

[![chat with me on Twitter](https://img.shields.io/badge/chat%20with%20me-on%20Twitter-1da1f2.svg)](https://twitter.com/derhuerst)

## Installation

```shell

npm install sepa-payment-qr-code

```

## Usage

```js

// generate-qr-code.js

const generateQrCode = require('sepa-payment-qr-code')

const qr = generateQrCode({

	name: 'Red Cross of Belgium',

	iban: 'BE72000000001616',

	amount: 123.45,

	unstructuredReference: 'Urgency fund',

	information: 'Sample QR code'

})

process.stdout.write(qr)

```

```shell

node generate-qr-code.js | qrencode -t ansiutf8 -l M

# prints QR code to the terminal

```

This library only generates the text input to be QR-encoded. Use the library of your choice to render the QR code to PNG/SVG/React/etc.

Note the following limitations posed by [European Payments Council's (EPC) *Quick Response Code: Guidelines to Enable Data Capture

for The Initiation of a Sepa Credit Transfer* document](https://www.europeanpaymentscouncil.eu/sites/default/files/KB/files/EPC069-12%20v2.1%20Quick%20Response%20Code%20-%20Guidelines%20to%20Enable%20the%20Data%20Capture%20for%20the%20Initiation%20of%20a%20SCT.pdf):

> 2 2D Code Guidelines

> Definition:

> - QR code error level `M` (15% of code words can be restored)

> - Maximum QR code version `13`, equivalent to module size `69` or 331 byte payload

> - Character sets:

> 	- UTF-8

> 	- ISO 8859-1

> 	- ISO 8859-2

> 	- ISO 8859-4

> 	- ISO 8859-5

> 	- ISO 8859-7

> 	- ISO 8859-10

> 	- ISO 8859-15

Also note that EPC QR codes are always in euros (`EUR`).

## See also

- [EPC QR code – Wikipedia](https://en.wikipedia.org/wiki/EPC_QR_code)

- [*Quick Response Code: Guidelines to Enable Data Capture for the Initiation of a SEPA Credit Transfer* EPC document](https://www.europeanpaymentscouncil.eu/document-library/guidance-documents/quick-response-code-guidelines-enable-data-capture-initiation)

- [Credit Transfer Payment API – W3C](https://w3c.github.io/payment-method-credit-transfer/)

## Contributing

If you have a question or need support using `sepa-payment-qr-code`, please double-check your code and setup first. If you think you have found a bug or want to propose a feature, refer to [the issues page](https://github.com/derhuerst/sepa-payment-qr-code/issues).