Account-Balance-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

Egyenleg lekérdezése

GET /Account/Balance

Az alábbi hívással lekérdezhető egy adott felhasználó aktuális egyenlege. A felhasználó azonosításához szükséges paraméterek ellenőrzése után a rendszer visszaadja az egyenleg értékét, vagy hibás azonosítás esetén a felmerülő hibá(ka)t.

A Barion ezt a hívást használja a pillanatnyi egyenleg megállapításához, a mobilalkalmazás pedig az egyes tranzakciók után ezen a híváson keresztül kérdezi le a felhasználó egyenlegének aktuális értékét.

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

Kimenet

Mező Típus Leírás Formátum / Példa
Balance decimal A felhasználó aktuális egyenlege. 5000
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.

Példák

Sikeres egyenleglekérdezés

Az alábbi példában látható egy sikeres egyenleglekérdezés.

Bemenet

https://api.barion.com/Account/Balance?UserName=pistike@example.com&Password=EgySimaJelszo

Kimenet

{
    "Balance": 5000,
    "ErrorList": []
}

Sikertelen egyenleglekérdezés

Sikertelen azonosítás

Ebben a példában nem sikerült lekérdezni az egyenleget, mert a megadott felhasználónévhez rossz jelszót küldtünk.

Bemenet

https://api.barion.com/Account/Balance?UserName=pistike@example.com&Password=MasikJelszo

Kimenet

{
  "Balance": 0,
  "ErrorList": [
    {
      "ErrorNumber": 1,
      "ErrorMessage": "A felhasználói név vagy jelszó nem megfelelő!",
      "Details": null
    }
  ]
}

Hiányzó paraméter

Az alábbi példában nem sikerült lekérdezni az egyenleget, mert nem adtunk meg felhasználónevet és jelszót.

Bemenet

https://api.barion.com/Account/Balance

Kimenet

{
  "Balance": 0,
  "ErrorList": [
    {
      "ErrorNumber": 2001,
      "ErrorMessage": "Validation Error: UserName Value: The UserName field is required.",
      "Details": null
    },
    {
      "ErrorNumber": 2001,
      "ErrorMessage": "Validation Error: Password Value: The Password field is required.",
      "Details": null
    },
    {
      "ErrorNumber": 1,
      "ErrorMessage": "A felhasználói név vagy jelszó nem megfelelő!",
      "Details": null
    }
  ]
}