bysquare
v2.11.0
Published
It's a national standard for payment QR codes adopted by Slovak Banking Association (SBA)
Downloads
1,029
Maintainers
xsemanReadme
bysquare
Simple JavaScript library to encode and decode "PAY by square" string.
What is PAY by square?
It's 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.
Can I generate an image?
This library doesn't have a specific opinion and how the QR code string is transformed into images depends on how you implement it. See examples.
Features
- Encode data to qr string
- Decode data to json
- Detect bysquare from qr string
Installation
[!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 registry
npm install bysquareCLI Node v18+
npm install --global bysquaredeno
Since v1.28+ import from npm registry using npm: prefix.
import {
decode,
encode,
} from "npm:bysquare@latest";Browser
<script type="module">
import { encode, decode } from "https://esm.sh/bysquare@latest";
</script>Usage
Encode
import {
CurrencyCode,
DataModel,
encode,
PaymentOptions,
} from "bysquare";
// string ready to be encoded to QR
const qrString = encode({
invoiceId: "random-id",
payments: [
{
type: PaymentOptions.PaymentOrder,
amount: 100.0,
bankAccounts: [
{
iban: "SK9611000000002918599669",
},
],
currencyCode: CurrencyCode.EUR,
variableSymbol: "123",
},
],
});Decode
import { decode } from "bysquare";
const model = decode(
"0405QH8090IFU27IV0J6HGGLIOTIBVHNQQJQ6LAVGNBT363HR13JC6CB54HSI0KH9FCRASHNQBSKAQD2LJ4AU400UVKDNDPFRKLOBEVVVU0QJ000",
);
// {
// invoiceId: "random-id",
// payments: [
// {
// type: 1,
// amount: 100.0,
// bankAccounts: [
// { iban: "SK9611000000002918599669" },
// ],
// currencyCode: "EUR",
// variableSymbol: "123",
// }
// ]
// }
//CLI
Encode
Encode JSON or JSONL data from files and print the corresponding QR code.
npx bysquare --encode file1.json file2.json...
npx bysquare --encode file.jsonlDecode
Decode the specified QR code string and print the corresponding JSON data. The qrstring argument should be a valid QR code string.
npx bysquare --decode <qrstring>How it works
Encoding sequence
Platform support
I mainly focus on LTS versions of Node.js and try to use the most idiomatic ECMAScript possible to avoid specific runtime coupling.
This doesn't mean that the library won't work on older versions, but it might not be as reliable.
As of v1.28, Deno now includes built-in support for npm modules and is ready
to use without additional setup, showing its improved maturity.
Node.js & Deno
- Node.js
v18and later. - Deno
v1.28and later.
Browser
The latest version of Chrome, Firefox, and Safari.
Troubleshooting & Recommendations
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 }).