API dokumentace

Generujte PAY by square a SPAYD QR kódy přes REST API

Bez autentizaceCORS povolen pro všechny zdrojeREST / JSON

Rychlý start#

Vygenerujte slovenský PAY by square QR kód jedním POST požadavkem:

curl

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

Nebo 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 autentizace#

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

- Bez autentizace
- CORS povolen pro všechny zdroje
- HTTPS only

Endpointy#

POST/api/v1/qr- Generování QR kódu

GET/api/v1/qr- Strojově čitelná JSON dokumentace

OPTIONS/api/v1/qr- CORS preflight

Parametry požadavku#

Odešlete JSON body s následujícími parametry 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 (Evropský SEPA) je dostupný ve webové aplikaci, ale zatím ne přes API.

Formát odpovědi#

Úspěch (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/cs/docs",
    "example": {
      "iban": "SK3112000000198742637541",
      "amount": 25.5
    }
  }
}

Zpracování chyb#

400VALIDATION_ERROR

Neplatné nebo chybějící parametry. Zkontrolujte pole issues pro chyby konkrétních polí.

400VALIDATION_ERROR(Invalid JSON)

Tělo požadavku není platný JSON. Ujistěte se, že posíláte správný JSON s Content-Type: application/json.

400VALIDATION_ERROR(Invalid IBAN)

IBAN neprošel validací. Musí začínat 2-písmenným kódem země a 2 kontrolními číslicemi.

400VALIDATION_ERROR(SPAYD payload)

SPAYD payload je příliš velký. Zkraťte paymentNote nebo recipientName.

429RATE_LIMIT

Příliš mnoho požadavků. Respektujte hlavičku Retry-After a implementujte exponenciální backoff.

500INTERNAL_ERROR

Neočekávaná chyba serveru. Zkuste to později nebo kontaktujte podporu.

Omezení rychlosti#

- 20 požadavků za minutu
- 100 požadavků za den
- GET a OPTIONS endpointy nejsou omezeny

Hlavičky odpovědi#

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

Implementujte exponenciální backoff při odpovědi 429. Cachujte QR kódy na vaší straně, když je to možné.

Pří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"
  }'

Vyzkoušejte#

Odešlete skutečný požadavek na API a podívejte se na odpověď:

← Zpět na hlavní stránku

API dokumentace

Generujte PAY by square a SPAYD QR kódy přes REST API

Bez autentizaceCORS povolen pro všechny zdrojeREST / JSON

Rychlý start#

Vygenerujte slovenský PAY by square QR kód jedním POST požadavkem:

curl

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

Nebo 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 autentizace#

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

- Bez autentizace
- CORS povolen pro všechny zdroje
- HTTPS only

Endpointy#

POST/api/v1/qr- Generování QR kódu

GET/api/v1/qr- Strojově čitelná JSON dokumentace

OPTIONS/api/v1/qr- CORS preflight

Parametry požadavku#

Odešlete JSON body s následujícími parametry 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 (Evropský SEPA) je dostupný ve webové aplikaci, ale zatím ne přes API.

Formát odpovědi#

Úspěch (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/cs/docs",
    "example": {
      "iban": "SK3112000000198742637541",
      "amount": 25.5
    }
  }
}

Zpracování chyb#

400VALIDATION_ERROR

Neplatné nebo chybějící parametry. Zkontrolujte pole issues pro chyby konkrétních polí.

400VALIDATION_ERROR(Invalid JSON)

Tělo požadavku není platný JSON. Ujistěte se, že posíláte správný JSON s Content-Type: application/json.

400VALIDATION_ERROR(Invalid IBAN)

IBAN neprošel validací. Musí začínat 2-písmenným kódem země a 2 kontrolními číslicemi.

400VALIDATION_ERROR(SPAYD payload)

SPAYD payload je příliš velký. Zkraťte paymentNote nebo recipientName.

429RATE_LIMIT

Příliš mnoho požadavků. Respektujte hlavičku Retry-After a implementujte exponenciální backoff.

500INTERNAL_ERROR

Neočekávaná chyba serveru. Zkuste to později nebo kontaktujte podporu.

Omezení rychlosti#

- 20 požadavků za minutu
- 100 požadavků za den
- GET a OPTIONS endpointy nejsou omezeny

Hlavičky odpovědi#

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

Implementujte exponenciální backoff při odpovědi 429. Cachujte QR kódy na vaší straně, když je to možné.

Pří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"
  }'

Vyzkoušejte#

Odešlete skutečný požadavek na API a podívejte se na odpověď:

← Zpět na hlavní stránku