QR-Generate-v1

A Barion wikiből
  • Tervezet
  • Üzlet
  • Informatika
  • Pénzügy
  • Jog
  • 99%
  • Online elfogadó
  • Mobil elfogadó
  • Pénztárgép
  • Feltöltés
  • Piactér
  • Nonprofit
  • Parkolas

QR kód generálása adott tranzakcióhoz

GET /QR/Generate

Az alábbi hívással előállítható egy QR kód egy adott fizetési tranzakcióhoz. A felhasználó ezt a QR kódot beolvasva végrehajthatja a tranzakciót saját mobil készülékével, ha más módon, például közelségi fizetéssel nem jut el hozzá a fizetési kérés. Az így generált QR kódot meg lehet jeleníteni például egy pénztárgépen.

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
UserName string Kötelező min. 6, max. 254 karakter nincs Az API hívás hívójának Barion azonosító e-mail címe. user@example.com
Password string Kötelező min. 8, max. 100 karakter nincs Az API hívás hívójának jelszava. EgySimaJelszo
TransactionId GUID Opcionális nincs nincs A tranzakció azonosítója, amelyhez a QR kódot generálni szeretnénk. fbc7ab21-1fce-42ca-aacb-d39bca8b0745
PaymentId GUID Opcionális nincs nincs A fizetési tranzakció azonosítója, amelyhez a QR kódot generálni szeretnénk. aaa7ab21-1fce-42ca-aacb-d39bca8b0799
Size string Opcionális nincs Large A generált QR kód kívánt mérete.
  • Small (50x50 px)
  • Normal (100x100 px)
  • Large (180x180 px)
Large

Kimenet

A kimenet minden hívás esetén hasonló felépítésű. Amennyiben sikeres hívás történt az ErrorList hibatömb üresen érkezik. Ha hiba történt, akkor a hibatömbben láthatóak ezek a hibák, de ilyen esetben is megkapjuk a többi kimeneti paramétert, csak üresen vagy pedig egy default alapértékkel.

Mező Típus Leírás Formátum / Példa
Image byte[] QR kód, amelyet a felhasználó a készülékével beolvasva a Barion mobilalkalmazásban végrehajthatja a tranzakciót (pl. vásárlás). A kép formátuma png. A kód tartalma egy olyan string, amit a Barion alkalmazás tud értelmezni, pl.: barion:?tid=308215c6-1096-4350-8cc0-ff821d1bece6
Barionqr1.png
ErrorList Errorlist A kérés során esetlegesen felmerülő hibákat tartalmazó tömb. Sikeres hívás esetén ez a tömb üres. Errorlist

Hibakódok

Hiba kódja Hiba leírása
1 Nem megfelelő felhasználónév vagy jelszó.
999 Ismeretlen hiba történt a kérés feldolgozása során.
2001 A bemeneti paraméterek valamelyike nem felelt meg az előírásoknak. Ez a hiba annyiszor szerepel(het) a kimenetben, ahány mező hibás volt. Ez esetben az ErrorMessage mezőben található a konkrét hiba: a Validation Error után látható a hibás mező megnevezése, a Value pedig a hiba leírását tartalmazza.
4003 A megadott tranzakció nem található vagy nem a bejelentkezett felhasználóhoz tartozik.

Példák

Sikeres hívás

Az alábbi hívásban a felhasználó egy QR kódot generál egy tranzakcióhoz. A rendszer által előállított kód képe látható a hívás válaszában.

Bemenet

https://api.barion.com/QR/Generate?UserName=pistike@example.com&Password=EgySimaJelszo&TransactionId=fbc7ab21-1fce-42ca-aacb-d39bca8b0745

Kimenet

Barionqr1.png

Sikertelen hívás

Az alábbi hívásban sikertelen hívást láthatunk; a megadott tranzakció azonosító érvénytelen.

Bemenet
https://api.barion.com/QR/Generate?UserName=pistike@example.com&Password=EgySimaJelszo&TransactionId=12345678-abcd-1234-abcd-123456789ab

Kimenet

{
  "ErrorList": [
    {
      "ErrorNumber": 4003,
      "ErrorMessage": "Invalid transaction!",
      "Details": null
    }
  ]
}