Transaction-StornoShopTransaction-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

Korábban kifizetett tranzakció sztornózása

POST /Transaction/StornoShopTransaction

Ezzel az API hívással lehet egy korábban már kifizetett tranzakciót visszavonni, sztornózni. Ilyenkor a Barionban a tranzakció összege és a hozzá tartozó borravaló visszautalásra kerül a vásárló tárcájába. A tranzakció kapcsán felszámolt jutalék nem visszautalható.

A Bariont integráló kasszák ezt a hívást használják arra, hogy egy korábbi tranzakciót visszavonjanak.

Fontos: csak sikeres lezárult tranzakciót lehet sztornózni, olyat ami még folyamatban van, nem lehet.

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 Kötelező nincs nincs Annak a tranzakciónak az azonosítója, amit sztornózni szeretnénk. "57210606-5e8a-4dc4-9bbf-9ba3b3769d69"

Kimenet

Mező Típus Leírás Formátum / Példa
isSuccessful boolean Jelzi, hogy az üzenetet a szerver befogadta és a vásárlónak a kiértesítését megkezdte. true
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.
4002 A megadott bolt azonosító nem létezik.
4003 Nem létező tranzakció vagy a tranzakció nem az API-t hívó felhasználóhoz tartozik.
4013 A tranzakció sztornózása nem sikerült rendszerhiba miatt.

Példák

Sikeres sztornó

Az alábbi példában a bolt sztornózza a 8cae53aa-b892-42ab-9a39-b1565d97858f azonoítójú tranzakciót.

Bemenet

{
  UserName: "bolt@example.com",
  Password: "EgySimaJelszo",
  TransactionId: "8cae53aa-b892-42ab-9a39-b1565d97858f"
}

Kimenet

{
    "IsSuccessful": true,
    "ErrorList": []
}