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

Legutóbbi tranzakciók lekérése

GET /Transaction/List

Ez a hívás lehetőséget ad a felhasználónak, hogy lekérdezze tranzakciós listáját. Ezek azok a tranzakciók,a miben a felhasználó valamilyen módon részt vett. Ez lehet pénzküldés, pénz fogadás, jutalék fizetés, parkolás vagy akár feltöltés is. Az egyes tranzakciók hordoznak minden olyan információt, aminek segítségével eldönthető, hogy miként szeretnénk megjeleníteni.

A Barion webes felület és a mobil alkalmazás egyaránt ezt a hívást használja a tranzakciótörténetben történő navigáció megvalósításához.

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
LastRequestTime DateTime Opcionális nincs nincs Az a legrégebbi időpont, ahonnan a listázást indítani szeretnénk. Az ennél régebbi tranzakciók nem kerülnek listázásra. Tipikusan arra használatos, hogy időnként lekérjük a friss tranzakciókat. 2014-10-06 18:00:00
LastVisibleTransactionId GUID Opcionális nincs nincs A LastRequestTime "ellentéte". Annak a tranzakciónak az egyedi azonosítója, amelytől régebbi tranzakciókra vagyunk kíváncsiak. Ez a tranzakció nem szerepel a visszaadott listában, hanem csak a nála régebbiek. Amennyiben meg van adva, felülírja a LastRequestTime paraméter értékét. Tipikusan arra használatos, hogy a tranzakciós listában hátrafelé közlekedjünk. "9243cde9-c593-4bba-a00d-486e591445dd"
StartDate DateTime Opcionális nincs nincs Időablak kezdete. Ha meg van adva, csak azok a tranzakciók fognak megjelenni, amelyek ennél a dátumnál később történtek. UTC szerinti időpontot kell megadni! 2016-08-01 14:00:00
EndDate DateTime Opcionális nincs nincs Időablak vége. Ha meg van adva, csak azok a tranzakciók fognak megjelenni, amelyek ennél a dátumnál korábban történtek. UTC szerinti időpontot kell megadni! 2016-08-02 14:00:00
Count integer Opcionális nincs 20 Az eredmények maximális száma. Maximum ennyi tranzakciót fog visszaadni a rendszer. Fontos: bár a Count paraméter opcionális, előfordulhat, hogy a hívó feleslegesen kér le alapesetben 20 tranzakciót. Teljesítmény szempontból mindenképpen ajánlott, hogy ezt a paramétert híváskor explicit módon megadjuk, az adott körülményeknek megfelelő értékkel! 15

Kimenet

Mező Típus Leírás Formátum / Példa
TransactionList Transaction[] A legutóbbi n darab tranzakcióból álló tömb, ahol n a Count bemeneti paraméterben megadott érték. 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

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.

Megjegyzés: Amennyiben hibás időpontot küldünk be (pl. jövőbeli dátum), a rendszer nem jelez hibát. Ez esetben a kimenetben található TransactionList tömb egyszerűen üres lesz.

Példák

Sikeres lekérdezés

Az alábbi példában a felhasználó sikeresen lekérdezi a három legutóbbi tranzakciójának részleteit. Az első kettő egyszerű pénzküldés, a harmadik pedig egy bolti vásárlás.

Bemenet

https://api.barion.com/Transaction/List?UserName=pistike@example.com&Password=EgySimaJelszo&Count=3

Kimenet

{
    "TransactionList": [
        {
            "TransactionId": "03e61e3c-486d-4e66-9795-6175257a89d1",
            "Time": "2014-11-05T09:05:44.21",
            "Amount": -300,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "lemezbolt@example.com",
            "ToName": "Lemez eladás 2014",
            "FromBalance": 500,
            "Comment": null,
            "ComissionBySender": null,
            "Currency": "Forint",
            "TransactionType": 18,
            "RelatedTransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
            "Products": null,
            "ShopName": "",
            "IsParkingTransaction": false,
            "ShopGuid": "04ed8c89-c9bd-4c17-92f6-a0964587bbff",
            "AmountWithTip": 300,
            "RelatedTransactions": []
        },
        {
            "TransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
            "Time": "2014-11-05T09:04:43.807",
            "Amount": -1500,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "lemezbolt@example.com",
            "ToName": "Lemez eladás 2014",
            "FromBalance": 2000,
            "Comment": null,
            "ComissionBySender": null,
            "Currency": "Forint",
            "TransactionType": 1,
            "RelatedTransactionId": null,
            "Products": [],
            "ShopName": "BarionTestShop",
            "IsParkingTransaction": false,
            "ShopGuid": "04ed8c89-c9bd-4c17-92f6-a0964587bbff",
            "AmountWithTip": 1800,
            "RelatedTransactions": [
                {
                    "TransactionId": "03e61e3c-486d-4e66-9795-6175257a89d1",
                    "Time": "2014-11-05T09:05:44.21",
                    "Amount": -300,
                    "FromName": "Kovács Pistike",
                    "FromEmailAddress": "pistike@example.com",
                    "ToEmailAddress": "lemezbolt@example.com",
                    "ToName": "Lemez eladás 2014",
                    "FromBalance": 500,
                    "Comment": null,
                    "ComissionBySender": null,
                    "Currency": "Forint",
                    "TransactionType": 18,
                    "RelatedTransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
                    "Products": null,
                    "ShopName": "",
                    "IsParkingTransaction": false,
                    "ShopGuid": "04ed8c89-c9bd-4c17-92f6-a0964587bbff",
                    "AmountWithTip": 300,
                    "RelatedTransactions": []
                },
                {
                    "TransactionId": "f72d0d34-1620-4c7f-8f2d-180f5ecfcc1b",
                    "Time": "2014-11-05T09:05:44.21",
                    "Amount": 50,
                    "FromName": "Lemez eladás 2014",
                    "FromEmailAddress": "lemezbolt@example.com",
                    "ToEmailAddress": null,
                    "ToName": "Barion",
                    "FromBalance": 10000,
                    "Comment": null,
                    "ComissionBySender": null,
                    "Currency": "Forint",
                    "TransactionType": 0,
                    "RelatedTransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
                    "Products": null,
                    "ShopName": "",
                    "IsParkingTransaction": false,
                    "ShopGuid": "04ed8c89-c9bd-4c17-92f6-a0964587bbff",
                    "AmountWithTip": 50,
                    "RelatedTransactions": []
                }
            ]
        },
        {
            "TransactionId": "d1f056a8-9b3f-4239-9d66-70acc64f5032",
            "Time": "2014-11-05T08:54:35.901",
            "Amount": -2900,
            "FromName": "Kovács Pistike",
            "FromEmailAddress": "pistike@example.com",
            "ToEmailAddress": "lemezbolt@example.com",
            "ToName": "Lemez eladás 2014",
            "FromBalance": 4900,
            "Comment": "",
            "ComissionBySender": null,
            "Currency": "Forint",
            "TransactionType": 18,
            "RelatedTransactionId": "ca07df15-eba6-46fa-ad6a-74ed5f9bd47a",
            "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": "",
            "IsParkingTransaction": false,
            "ShopGuid": "04ed8c89-c9bd-4c17-92f6-a0964587bbff",
            "AmountWithTip": 2900,
            "RelatedTransactions": []
        },
        {
            "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": 6400,
            "Comment": null,
            "ComissionBySender": true,
            "Currency": "Forint",
            "TransactionType": 2,
            "RelatedTransactionId": null,
            "Products": null,
            "ShopName": null,
            "IsParkingTransaction": false,
            "ShopGuid": null,
            "AmountWithTip": 1500,
            "RelatedTransactions": []
        }
    ],
    "ErrorList": []
}