"PAY by square" is a national standard for QR code payments that was adopted by the Slovak Banking Association in 2013. It is incorporated into a variety of invoices, reminders and other payment regulations.
It's simple, I couldn't find any implementation of "PAY by square" standard for JavaScript, so I decided to create one and share it with the community to help individuals and businesses to create QR codes for their invoices.
- TypeScript support
- Compatible with Slovak banking apps
- Runtime-independent JavaScript implementation
Note
This package is native ESM and no longer provides a
CommonJS export. If your project uses CommonJS, you will have to convert to ESM
or use the dynamic import() function.
$ npm install bysquare<script type="module">
import { encode, decode } from "https://esm.sh/bysquare@latest";
</script>Simple helper functions to wrap encoding for most common use cases.
simplePayment- Encode simple payment data.directDebit- Encode direct debit data.standingOrder- Encode standing order data.
import { simplePayment } from "bysquare";
const qrstring = simplePayment({
amount: 100,
variableSymbol: "123456",
currencyCode: CurrencyCode.EUR,
iban: "SK9611000000002918599669",
});For more complex data use encode and decode functions:
Note
Encoded data are without diacritics
The library removes all diacritics from the input data to ensure maximum
compatibility, as not all banks support diacritics, which may lead to errors.
If you need to retain diacritics, disable deburr option when encoding data -
encode(model, { deburr: false }).
import {
CurrencyCode,
DataModel,
decode,
encode,
PaymentOptions,
} from "bysquare";
const data = {
invoiceId: "random-id",
payments: [
{
type: PaymentOptions.PaymentOrder,
currencyCode: CurrencyCode.EUR,
amount: 100.0,
variableSymbol: "123",
paymentNote: "hello world",
bankAccounts: [{ iban: "SK9611000000002918599669" }],
// ...more fields
},
],
} satisfies DataModel;
// Encode data to a QR string
const qrstring = encode(data);
// Decode QR string back to the original data model
const model = decode(qrstring);$ npm install --global bysquareEncode JSON or JSONL data from files and print the corresponding QR code.
$ bysquare --encode file1.json file2.json...
$ bysquare --encode file.jsonlDecode the specified QR code string and print the corresponding JSON data. The qrstring argument should be a valid QR code string.
$ bysquare --decode <qrstring>