Transaction-Detail-v1

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

Tranzakciók részleteinek lekérése

GET /Transaction/Detail

Ezzel a hívással lekérdezhető egy vagy több tranzakció részletei az egyedi azonosítójuk alapján. A kapott tranzakciókat a rendszer egy tömbben adja vissza, amely különálló Transaction objektumokat tartalmaz - annyit, amennyi azonosítót a hívó beküldött. Csak azon tranzakciók részletei kérhetők le, melyekben az API hívást indító felhasználó részt vesz (küldőként vagy fogadóként).

A Barion mobil alkalmazás és a webes felület egyaránt ezt a hívást használja a tranzakciótörténetben egy-egy adott tranzakció részleteinek lekérdezésére.

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
TransactionIds GUID[] Kötelező nincs nincs A részletezni kívánt tranzakciók azonosítóiból álló tömb.
[
     "fd282ec7-6ac2-4571-8e20-1726208cb93b", 
     "c82e38cc-6de0-41a1-8816-ee70c37f3c22"
]

Kimenet

Mező Típus Leírás Formátum / Példa
Transactions Transaction[] A beküldött azonosítók alapján összegyűjtött tranzakciókból álló tömb. Transaction[]
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

A beküldött tranzakció azonosítók száma nem feltétlenül egyezik meg a visszakapott tranzakciórészletek számával. Ennek oka a következő lehet:

  • Nem létezik tranzakció ezzel az azonosítóval a rendszerben.
  • Nem a hívást intéző felhasználóhoz tartozik a tranzakció.
  • A tranzakció értéke 0 Ft.
  • Befoglalásos tranzakció esetén, a lekért befoglalás sztornózásra került.

Előfordulhat, hogy egy olyan befoglalásos tranzakciót kérünk le, ami már véglegesítésre került. Ilyenkor nem a lekérdezett befoglalás részleteit kapjuk vissza, hanem a végleges fizetési tranzakciót. Hogy tudjuk, mi hova tartozik, ebben az esetben a visszakapott fizetési tranzakció objektum RelatedTransactionId mezőjében találhatjuk az eredeti befoglalásos tranzakció azonosítóját. Folyamatban lévő befoglalás esetén a befoglalásos tranzakció részleteit kapjuk vissza.

Ezeknek ismeretében érdemes a hívást intéző kliens kódjában megjegyezni, hogy milyen azonosítókat kértünk le, hogy a visszakapott tranzakciókat értelmezni tudjuk. Amennyiben egy lekért azonosítóhoz nem érkezik részlet, meg kell nézni, hogy szerepel-e valamelyik részlet RelatedTransactionId mezőjében az azonosító. Ha itt sem található, akkor ezt a tranzakciót törölni kell a kliensről.

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 lekérdezés

Az alábbi példában a felhasználó sikeresen lekérdezi két tranzakció részleteit. Az első egy egyszerű pénzküldés, a második pedig egy bolti vásárlás.

Bemenet

https://api.barion.com/Transaction/Detail?UserName=pistike@example.com&Password=EgySimaJelszo&TransactionIds[]=ea42f3ae-a6aa-449e-a6f8-e681b7fad966&TransactionIds[]=fd282ec7-6ac2-4571-8e20-1726208cb93b

Kimenet

{
    "Transactions": [
        {
            "TransactionId": "ea42f3ae-a6aa-449e-a6f8-e681b7fad966",
            "Time": "2014-10-02T08:37:55.62",
            "Amount": -1500,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "moricka@example.com",
            "ToName": null,
            "FromBalance": 11020,
            "Comment": null,
            "ComissionBySender": true,
            "Currency": "Forint",
            "TransactionType": 2,
            "RelatedTransactionId": null,
            "Products": null,
            "ShopName": null,
            "IsParkingTransaction": false,
            "ShopGuid": null,
            "AmountWithTip": 1500
        },
        {
            "TransactionId": "fd282ec7-6ac2-4571-8e20-1726208cb93b",
            "Time": "2014-10-01T18:34:44.32",
            "Amount": -2900,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "barionruhazat@example.com",
            "ToName": "Barion Ruházat Kft.",
            "FromBalance": 12520,
            "Comment": null,
            "ComissionBySender": null,
            "Currency": "Forint",
            "TransactionType": 1,
            "RelatedTransactionId": null,
            "Products": [
              {
                "Name": "Barion póló L",
                "Description": "Barion férfi környakú póló L-es méret",
                "Quantity": 1,
                "Unit": db,
                "Price": 2900,
                "SKU": "BPOLO_L_1337"
              }
            ],
            "ShopName": "Barion Ruházat 2014",
            "IsParkingTransaction": false,
            "ShopGuid": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
            "AmountWithTip": 3000
        }
    ],
    "ErrorList": []
}

Véglegesített befoglalás lekérdezése

Az alábbi példában a 052a1725-fece-4d4d-a5b3-2e1aadb0853a azonosítójú befoglalásról szeretnénk megtudni, hogy milyen állapotban van. A válaszból látjuk, hogy a befoglalt összegből 1500 Ft-nyit fizettünk ki.

Bemenet

https://api.barion.com/Transaction/Detail?UserName=pistike@example.com&Password=EgySimaJelszo&TransactionIds[]=ea42f3ae-a6aa-449e-a6f8-e681b7fad966

Kimenet

{
    "Transactions": [
        {
            "TransactionId": "e7627de2-cad2-4d37-af3a-b3d277031b12",
            "Time": "2014-10-02T08:37:55.62",
            "Amount": -1500,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "moricka@example.com",
            "ToName": null,
            "FromBalance": 11020,
            "Comment": null,
            "ComissionBySender": true,
            "Currency": "Forint",
            "TransactionType": 1,
            "RelatedTransactionId": null,
            "Products": null,
            "ShopName": null,
            "IsParkingTransaction": false,
            "RelatedTransactionId": "ea42f3ae-a6aa-449e-a6f8-e681b7fad966",
            "ShopGuid": null,
            "AmountWithTip": 1500
        }
    ],
    "ErrorList": []
}