TopUp-Check-v2

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

Feltöltés előtti ellenőrzés

POST v2/TopUp/Check

Ezzel a metódossal kell ellenőrzi feltöltés előtt, hogy a megadott azonosító a Barion rendszerben regisztrált felhasználóhoz van-e kötve. Amennyiben a felhasználó nem létezik, megszűnt a számlája, vagy egyéb okból a feltöltés nem lehetséges, a hívás a hiba okának megfelelő hibakódot és szöveget ad vissza. Csak akkor szabad feltöltés kezdeményezni a TopUp-Execute-v2 hívással, ha az ellenőrző hívás eredménye pozitív.

A feltöltés menetének leírása: TopUp-v2

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
CashTopUpPartnerId string Kötelező Ésszerű hosszúság, ami elfér egy nyugtán nincs A feltöltés végző partner cég márkanave és egyben azonosítója, amely megjelenhet a felhasználónak, például a nyugtán SzuperAutomata
CashTopUpPartnerSecretKey GUID Kötelező nincs nincs A feltöltés végző partner cég titkos azonosítója, melyet szerződéskötéskor kap meg 4ccd8cc5-1fff-42fc-a126-63280688da02
TopUpCode string Kötelező csak számjegyek, max. 20 karakter nincs A terminálon megadott Barion feltöltőkód vagy telefonszám 063012345678

Kimenet

A kimenet minden hívás esetén hasonló felépítésű. Amennyiben sikeres hívás történt az Error hibatömb üresen érkezik, ha hiba történt, akkor csak a hibatömb érkezik válaszként, amiben láthatóak a hibák.

Mező Típus Leírás Formátum / Példa
CashTopUpAllowed Bool
  • true: a feltöltés engedélyezett
  • false: a feltöltés nem engedélyezett

true

ErrorList Errorlistv2 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. Errorlistv2

Hibakódok

Hiba kódja Hiba leírása
topup-check-invalidsecretkey Invalid Secret key format
topup-check-authfailed Authorization failed: Partner ID and Secret key do not match
topup-check-badtopupcode TopUpCode format is incorrect (Az azonosító formátuma nem érvényes)

Példák

Sikeres ellenőrzés

Az alábbi példában a SzuperAutomata feltöltőpartner a BUD-XI-24 es azonosítójú automatánál kér ellenőrzést a 063012345678 feltöltőkódra. A hívás sikeres, a feltöltés megkezdhető.

Bemenet

{
   CashTopUpPartnerId: "SzuperAutomata",
   CashTopUpPartnerSecretKey: "4ccd8cc5-1fff-42fc-a126-63280688da02",
   CashTopUpPointId: "BUD-XI-24",
   TopUpCode: "063012345678"
}

Kimenet

{
   CashTopUpAllowed: true,
   ErrorList : []
}

Sikeres ellenőrzés, negatív válasszal

Az alábbi példában a SzuperAutomata feltöltőpartner a BUD-XI-24 es azonosítójú automatánál kér ellenőrzést a 123456789 feltöltőkódra. A hívás azt jelzi, hogy a feltöltés nem kezdhető meg, mert a feltöltőkódhoz nem tartozik feltölthető számla.

Bemenet

{
   CashTopUpPartnerId: "SzuperAutomata",
   CashTopUpPartnerSecretKey: "4ccd8cc5-1fff-42fc-a126-63280688da02",
   CashTopUpPointId: "BUD-XI-24",
   TopUpCode: "123456789"
}

Kimenet

{
   CashTopUpAllowed: false,
   ErrorList: []
}

Sikertelen ellenőrzés

Az alábbi példában a SzuperAutomata feltöltőpartner a BUD-XI-24 es azonosítójú automatánál kér ellenőrzést a 123456789 feltöltőkódra, de a titkos azonosítóját hibásan adja meg. A szerver így visszautasítja a hívást.

Bemenet

{
   CashTopUpPartnerId: "SzuperAutomata",
   CashTopUpPartnerSecretKey: "111111111111-22222222222",
   CashTopUpPointId: "BUD-XI-24",
   TopUpCode: "123456789"
}

Kimenet

{
   ErrorList: [
   { 
      ErrorCode: "topup-check-authfailed", 
      ErrorMessage: "Authorization failed: Partner ID and Secret key do not match"
      Details: [
      {
         CashTopUpPartnerId: "SzuperAutomata",
         CashTopUpPartnerSecretKey: "111111111111-22222222222"
      }]
   },
   {
      ErrorCode: "topup-check-invalidsecretkey", 
      ErrorMessage: "Invalid Secret key format"
      Details: [
      {
         CashTopUpPartnerSecretKey: "111111111111-22222222222"
      }]
   }]
}