REST API

Integrujte štandard by square

JSON REST API endpointy

Na autorizáciu voči API pošlite Authorization: api key hlavičku. API kľúč môžete vygenerovať pod účtom v dashboarde.

Odosielajte JSON s Content-Type: application/json.

GEThttps://api.bysquare.com/info

Vráti informácie o používateľovi a zostatku kreditov.

Ukážka odpovede

{
  "companyName": "My Company",
  "planName": "Wise",
  "nextReset": 1771296662,
  "generations": {
    "available": 27400,
    "remaining": 2952,
    "used": 24448
  },
  "reads": {
    "available": 2400,
    "remaining": 1480,
    "used": 920
  }
}

POSThttps://api.bysquare.com/generate/pay?formats=pay

Vygeneruje PAY by square QR obrázok.

Payload požiadavky

{
  "payments": [
    {
      "amount": 1,
      "currencyCode": "EUR",
      "bankAccounts": {
        { "iban": "SK0000000000000" }
      },
      "beneficiaryName": "A",
      "paymentNote": "Payment for products",
      "variableSymbol": 12345
    }
  ]
}

Ukážka odpovede

{
  "contentType": "image/png",
  "format": "pay",
  "image": "iVBORw0KG...base64 encoded data",
  "payload": "0003G000FQ5D2ING92PTN9NSUVOENM25ALB59SIMJKNBAJQ244S31UOGUAH7C4ULCGBEGV34FG00"
}

GET

https://api.bysquare.com/generate/pay?key=YOUR_API_KEY&iban=SK&beneficiary=A&amount=1&currency=EUR&vs=12345&note=payment+note&format=pay

Rýchly endpoint na generovanie QR obrázka jedným GET volaním.

POSThttps://api.bysquare.com/generate/invoice

Vygeneruje by square payload faktúry.

POSThttps://api.bysquare.com/read

Dekóduje by square payload a uloží dokument na server.

POSThttps://api.bysquare.com/read/file

Dekóduje nahraný súbor (JPG/PNG/PDF) a vráti štruktúrované údaje.

Kompletná API dokumentácia

Ostatné materiály

by square – Generator Test

Generator Test je rýchly sandbox, kde si môžete generovať a testovať QR kódy by square.

by square – PAY špecifikácia

Preskúmajte PAY by square špecifikáciu, ktorá pokrýva formáty platobných QR kódov, povinné polia a validačné pravidlá.

by square – XML špecifikácia pôvodného API

Tento dokument je XML špecifikácia pre prístup k pôvodnému API na app.bysquare.com/api