Dokumentácia
Pay By Square
QRGenerator.sk podporuje tvorbu QR kódov v proprietárnom formáte Pay By Square, podľa dostupnej dokumentácie Slovenskej Bankovej Asociácie.
QR je k dispozícií v týchto variantách:
- png/jpeg na priame použitie v
<img>
tagu - png/jpeg vo formáte base64 stringu
- QR string na ďalšie použitie
QR ako png/jpeg
Obrázok generujú dva endpointy:
https://api.qrgenerator.sk/by-square/pay/qr.png
a
https://api.qrgenerator.sk/by-square/pay/qr.jpg
Endpoint vygeneruje validný QR kód iba v prípade, ak je zavolaný so správnymi parametrami uverenými v URL query. Zoznam dostupných parametrov:
Parametre
iban
- povinné - číslo účtu prijímateľa platby vo formáte IBANamount
- povinné - suma transakcie, napr. 1200.99currency
- voliteľné - mena transakcie. default: EURdue_date
- voliteľné - dátum splatnosti transakcie, formát yyyy-MM-dd, napr. 2020-12-31vs
- voliteľné - variabilný symbolss
- voliteľné - špecifický symbolcs
- voliteľné - konštantný symbolpayment_note
- voliteľné - poznámka k platbebeneficiary_name
- voliteľné - meno príjemcubeneficiary_address1
- voliteľné - adresa príjemcu 1beneficiary_address2
- voliteľné - adresa príjemcu 2-
mode
- voliteľné - možnosti:- full - branding rám okolo QR kódu
- bottom - branding logo pod QR kódom
- none - bez brandingu
-
size
- voliteľné - veľkost výsledného obrázka, možnosti:- 128 - veľkost 128px, default
- 256 - veľkost 256px
- 512 - veľkost 512px
-
transparent
- voliteľné - priehľadnoť výsledného QR kódu. Možnosti- true - priehľadný
- false - biele pozadie
Príklad
HTML
<img
src="https://api.QRGenerator.sk/by-square/pay/qr.png?
iban=SK8975000000000012345671&
amount=10&
currency=EUR&
vs=20200001&
payment_note=poznamka&
due_date=2024-11-21&
size=128&
transparent=false"
alt="QR kod"
/>
Náhľad
Veľkosť obrázka
Veľkosť vygenerovaného obrázka s QR kódom určuje parameter size. Z praktických skúsenosti doporučujem vygenerovať vačší QR kód a následne nechať prehliadač alebo PDF renderer aby urobil primeraný downscalling. Výsledná čitateľnost QR kódu je lepšia, ako pri opačnom postupe, ked vygenerujeme menší obrázok a urobíme upscalling. Napr. ak požadujem obrázok o zhruba velkosťi 400px, requestujem radšej veľkost 512 a robím downscalling, ako 256 s upscallingom.
512px
Downscalling
512px obrázok nastavený na 25% šírku
128px
Downscalling
128px obrázok nastavený na 25% šírku
Upscalling
512px obrázok nastavený na 100% šírku
Upscalling
128px obrázok nastavený na 100% šírku
QR ako base64
Base64 string je dostupný na endpointehttps://api.qrgenerator.sk/by-square/pay/base64
Parametre
Kombináciu parametrov je nutné posielať v URL.- parametre pre PNG/JPG variant +
format
- povinné - výstupný formát obrázka - png / jpeg / bmpunit_size
- voliteľné - počet pixelov na segment QR kódu
Príklad
GET Request
https://api.QRGenerator.sk/by-square/pay/base64?format=png&iban=SK8975000000000012345671&amount=10¤cy=EUR&vs=20200001&payment_note=poznamka&due_date=2024-11-21&unit_size=10
Response
{
"mime" : "image/png",
"data" : "iVBORw0KGgoAAAANSUhEUgAAAIAAAACWCAYAAAAWsYBNAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAA7XSURB................."
}
QR String
Vstupný text resp. string na vygenerovanie QR kódu je dostupný na endpointehttps://api.qrgenerator.sk/by-square/pay/string
Parametre
Kombináciu parametrov je nutné posielať v URL.iban
- povinné - číslo účtu prijímateľa platby vo formáte IBANamount
- povinné - suma transakcie, napr. 1200.99currency
- voliteľné - mena transakcie. default: EURdue_date
- voliteľné - dátum splatnosti transakcie, formát yyyy-MM-dd, napr. 2020-12-31vs
- voliteľné - variabilný symbolss
- voliteľné - špecifický symbolcs
- voliteľné - konštantný symbolpayment_note
- voliteľné - poznámka k platbebeneficiary_name
- voliteľné - meno príjemcubeneficiary_address1
- voliteľné - adresa príjemcu 1beneficiary_address2
- voliteľné - adresa príjemcu 2
Príklad
GET Request
https://api.QRGenerator.sk/by-square/pay/string?iban=SK8975000000000012345671&amount=10¤cy=EUR&vs=20200001&payment_note=poznamka&due_date=2024-11-21
Response
{
"data" : "0006E000CODK3AOG9C62MCETHLG0V9OP3H32ERPJJD47BBTH9G4SVC9VOTTG6GQS8C18FTDIN5EAMJR1MCAU0PDGQQIA13VK2R00C7KO79KKM9P80"
}
Bezpečnost
Webstránka používa Cookies a Google Analytics.
API žiadnym spôsobom poskutnuté údaje neukladá, nezdieľa ani neposieľa ďalej. Príjme, spracuje, vráti a zabudne.
Služba beží na .NET 6 a využíva GitHub open source projekty. Hosting je v Českej republike - FORPSI.com.
Kontakt
Otázky, podnety, postrehy, bug reporty na ahoj@QRGenerator.sk
Služba je poskytovaná bezplatne. Podmienkou bezplatného používania je dodržiavanie FUP - Fair Use Policy. Vaše správanie a používanie nesmie byť obmedzujúce a obťažujúce pre iných používateľov.