search

xseman / bysquare

Encode & Decode "PAY by square" QR string.
https://xseman.github.io/bysquare/
Apache License 2.0
26 stars 4 forks source link
banking bysquare cli paybysquare payment qr-code qr-string qr-string-generaor

readme

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

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 bysquare

CLI Node v18+

npm install --global bysquare

deno

Since v1.28+ import from npm registry using npm: prefix.

import { decode, encode } from "npm:bysquare@2.8.0";

Browser

<script type="module">
    import { encode, decode } from "https://esm.sh/bysquare@2.8.0/";
</script>

How it works

Encoding sequence

logic

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.jsonl

Decode

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>

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

Browser

The latest version of Chrome, Firefox, and Safari.

Related