API dokumentácia

Generujte PAY by square a SPAYD QR kódy cez REST API

Bez autentifikácieCORS povolený pre všetky zdrojeREST / JSON

Rýchly štart#

Vygenerujte slovenský PAY by square QR kód jedným POST requestom:

curl

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{"iban":"SK3112000000198742637541","amount":25.50,"variableSymbol":"2024001"}'

Alebo vygenerujte český SPAYD QR kód:

curl

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{"iban":"CZ6508000000192000145399","amount":480.50,"currency":"CZK","paymentFormat":"spayd"}'

Základná URL a autentifikácia#

https://qr-platby.com/api/v1/qr

- Bez autentifikácie
- CORS povolený pre všetky zdroje
- HTTPS only

Endpointy#

POST/api/v1/qr- Generovanie QR kódu

GET/api/v1/qr- Strojovo čitateľná JSON dokumentácia

OPTIONS/api/v1/qr- CORS preflight

Parametre requestu#

Odošlite JSON body s nasledujúcimi parametrami na POST endpoint:

Name	Type	Required	Default	Validation	Description
iban	string	Required	-	Valid IBAN format	Recipient IBAN (e.g. SK3112000000198742637541)
amount	number	Optional	-	0.01 - 999,999,999.99	Payment amount
currency	string	Optional	EUR	EUR \| CZK	Payment currency
variableSymbol	string	Optional	-	Up to 10 digits	Variable symbol (digits only)
specificSymbol	string	Optional	-	Up to 10 digits	Specific symbol (digits only)
constantSymbol	string	Optional	-	Up to 4 digits	Constant symbol (digits only)
recipientName	string	Optional	-	Up to 70 characters	Recipient name
paymentNote	string	Optional	-	Up to 140 characters	Payment note / message
paymentFormat	string	Optional	bysquare	bysquare \| spayd	QR standard. bysquare for Slovak banks (PAY by square), spayd for Czech banks (QR Platba)
format	string	Optional	png	png \| svg	Output format. png returns base64 data URI, svg returns SVG markup
size	integer	Optional	300	100 - 1000	QR code size in pixels (png only)

EPC QR (Európsky SEPA) je dostupný vo webovej aplikácii, ale zatiaľ nie cez API.

Formát odpovede#

Úspech (200)#

json

{
  "success": true,
  "data": "data:image/png;base64,iVBORw0KGgo...",
  "format": "png",
  "iban": "SK3112000000198742637541",
  "amount": 25.5,
  "currency": "EUR"
}

Chyba#

json

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed. Check the issues array for details.",
    "issues": [
      { "path": "iban", "message": "Invalid IBAN" }
    ],
    "hint": "Required: iban (string). Optional: amount, currency, ...",
    "docs": "https://qr-platby.com/docs",
    "example": {
      "iban": "SK3112000000198742637541",
      "amount": 25.5
    }
  }
}

Spracovanie chýb#

400VALIDATION_ERROR

Neplatné alebo chýbajúce parametre. Skontrolujte pole issues pre chyby konkrétnych polí.

400VALIDATION_ERROR(Invalid JSON)

Telo requestu nie je platný JSON. Uistite sa, že posielate správny JSON s Content-Type: application/json.

400VALIDATION_ERROR(Invalid IBAN)

IBAN neprešiel validáciou. Musí začínať 2-písmenným kódom krajiny a 2 kontrolnými číslicami.

400VALIDATION_ERROR(SPAYD payload)

SPAYD payload je príliš veľký. Skráťte paymentNote alebo recipientName.

429RATE_LIMIT

Príliš veľa requestov. Rešpektujte hlavičku Retry-After a implementujte exponenciálny backoff.

500INTERNAL_ERROR

Neočakávaná chyba servera. Skúste neskôr alebo kontaktujte podporu.

Obmedzenie rýchlosti#

- 20 requestov za minútu
- 100 requestov za deň
- GET a OPTIONS endpointy nie sú obmedzené

Hlavičky odpovede#

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 17
Retry-After: 45  (only on 429)

Implementujte exponenciálny backoff pri odpovedi 429. Kešujte QR kódy na vašej strane, keď je to možné.

Príklady kódu#

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{
    "iban": "SK3112000000198742637541",
    "amount": 25.50,
    "currency": "EUR",
    "variableSymbol": "2024001"
  }'

Vyskúšajte#

Odošlite skutočný request na API a pozrite si odpoveď:

← Späť na hlavnú stránku

API dokumentácia

Generujte PAY by square a SPAYD QR kódy cez REST API

Bez autentifikácieCORS povolený pre všetky zdrojeREST / JSON

Rýchly štart#

Vygenerujte slovenský PAY by square QR kód jedným POST requestom:

curl

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{"iban":"SK3112000000198742637541","amount":25.50,"variableSymbol":"2024001"}'

Alebo vygenerujte český SPAYD QR kód:

curl

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{"iban":"CZ6508000000192000145399","amount":480.50,"currency":"CZK","paymentFormat":"spayd"}'

Základná URL a autentifikácia#

https://qr-platby.com/api/v1/qr

- Bez autentifikácie
- CORS povolený pre všetky zdroje
- HTTPS only

Endpointy#

POST/api/v1/qr- Generovanie QR kódu

GET/api/v1/qr- Strojovo čitateľná JSON dokumentácia

OPTIONS/api/v1/qr- CORS preflight

Parametre requestu#

Odošlite JSON body s nasledujúcimi parametrami na POST endpoint:

Name	Type	Required	Default	Validation	Description
iban	string	Required	-	Valid IBAN format	Recipient IBAN (e.g. SK3112000000198742637541)
amount	number	Optional	-	0.01 - 999,999,999.99	Payment amount
currency	string	Optional	EUR	EUR \| CZK	Payment currency
variableSymbol	string	Optional	-	Up to 10 digits	Variable symbol (digits only)
specificSymbol	string	Optional	-	Up to 10 digits	Specific symbol (digits only)
constantSymbol	string	Optional	-	Up to 4 digits	Constant symbol (digits only)
recipientName	string	Optional	-	Up to 70 characters	Recipient name
paymentNote	string	Optional	-	Up to 140 characters	Payment note / message
paymentFormat	string	Optional	bysquare	bysquare \| spayd	QR standard. bysquare for Slovak banks (PAY by square), spayd for Czech banks (QR Platba)
format	string	Optional	png	png \| svg	Output format. png returns base64 data URI, svg returns SVG markup
size	integer	Optional	300	100 - 1000	QR code size in pixels (png only)

EPC QR (Európsky SEPA) je dostupný vo webovej aplikácii, ale zatiaľ nie cez API.

Formát odpovede#

Úspech (200)#

json

{
  "success": true,
  "data": "data:image/png;base64,iVBORw0KGgo...",
  "format": "png",
  "iban": "SK3112000000198742637541",
  "amount": 25.5,
  "currency": "EUR"
}

Chyba#

json

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed. Check the issues array for details.",
    "issues": [
      { "path": "iban", "message": "Invalid IBAN" }
    ],
    "hint": "Required: iban (string). Optional: amount, currency, ...",
    "docs": "https://qr-platby.com/docs",
    "example": {
      "iban": "SK3112000000198742637541",
      "amount": 25.5
    }
  }
}

Spracovanie chýb#

400VALIDATION_ERROR

Neplatné alebo chýbajúce parametre. Skontrolujte pole issues pre chyby konkrétnych polí.

400VALIDATION_ERROR(Invalid JSON)

Telo requestu nie je platný JSON. Uistite sa, že posielate správny JSON s Content-Type: application/json.

400VALIDATION_ERROR(Invalid IBAN)

IBAN neprešiel validáciou. Musí začínať 2-písmenným kódom krajiny a 2 kontrolnými číslicami.

400VALIDATION_ERROR(SPAYD payload)

SPAYD payload je príliš veľký. Skráťte paymentNote alebo recipientName.

429RATE_LIMIT

Príliš veľa requestov. Rešpektujte hlavičku Retry-After a implementujte exponenciálny backoff.

500INTERNAL_ERROR

Neočakávaná chyba servera. Skúste neskôr alebo kontaktujte podporu.

Obmedzenie rýchlosti#

- 20 requestov za minútu
- 100 requestov za deň
- GET a OPTIONS endpointy nie sú obmedzené

Hlavičky odpovede#

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 17
Retry-After: 45  (only on 429)

Implementujte exponenciálny backoff pri odpovedi 429. Kešujte QR kódy na vašej strane, keď je to možné.

Príklady kódu#

curl -X POST https://qr-platby.com/api/v1/qr \
  -H "Content-Type: application/json" \
  -d '{
    "iban": "SK3112000000198742637541",
    "amount": 25.50,
    "currency": "EUR",
    "variableSymbol": "2024001"
  }'

Vyskúšajte#

Odošlite skutočný request na API a pozrite si odpoveď:

← Späť na hlavnú stránku