Payment-GetTransactionState-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

Tranzakció állapotának lekérdezése

POST /Payment/GetTransactionState

Az alábbi hívással lekérdezhetők egy adott tranzakció adatai az egyedi azonosítója alapján. A Barion által küldött válaszban megtalálható a tranzakció időpontja, összege, a hozzá kapcsolódó termékek (ha vannak), a tranzkació típusa, státusza, illetve egyéb paraméterei.

A Barion rendszer ezt az API hívást használja az egyes folyamatban levő tranzakciók státuszának ellenőrzésére például online fizetés közben.

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
TransactionId GUID Kötelező nincs nincs A tranzakció Barionban található egyedi azonosítója. d2645361-32f9-4efa-9497-e536c8d92489

Megyjegyzés: ehhez az API híváshoz nem kell authentikációs paramétereket küldeni!

Kimenet

Mező Típus Leírás Formátum / Példa
TransactionId GUID A tranzakció egyedi azonosítója; azonos a bemeneti paraméterrel. d2645361-32f9-4efa-9497-e536c8d92489
Amount integer A tranzakció összege ezres elválasztók és pénznem feltüntetése nélkül. 5000
Status byte A tranzakció állapota, a TransactionStatus-v1 értékei alapján. 1
StartTime string A tranzakció indításának időpontja. 2014-10-28T12:42:58.973
EndTime string A tranzakció véglegesítésének időpontja. Folyamatban levő (nem véglegesített) tranzakció esetén null. 2014-10-28T12:43:06.000
RelatedId GUID Ha van kapcsolódó tranzakció, akkor annak az azonosítója. a264f361-32f9-4efa-9497-e536cbd924ff
ApplicationId GUID A tranzakcióhoz tartozó bolt azonosítója. c82e38cc-6de0-41a1-8816-ee70c37f3c22
ShopTransactionId string A tranzakció egyedi azonosítója a bolt saját rendszerében. TRANS0001
Products Products A tranzakcióhoz tartozó termékek listája. Products
Error Errorlist Az állapotlekérés során esetlegesen felmerülő problémák leírása. Errorlist
TipOption TipOption Amennyiben a tranzakciót bonyolító bolthoz kapcsolódik borravaló beállítás, akkor azok itt találhatók meg. TipOption
To TransactionRecipient A pénzt fogadó fél adatai. TransactionRecipient
ShopName string Amennyiben a tranzakció egy bolti vásárlás, a tranzakciót indító bolt neve. Kovács és Társa Kft.
TransactionDetails TransactionDetailModel A tranzakcióhoz kapcsolódó tranzakciók részletei Transaction

Hibakódok

Hiba kódja Hiba leírása
1101 Hibás formátumú tranzakcióazonosító.
1102 Nem létező tranzakció, a megadott tranzakció azonosító bár formailag helyes, nem található az adatbázisban.

Példák

Sikeres hívás

Pénzküldés tranzakció

Az alábbi példában sikeresen lekérdezzük egy 1000 Ft összegű pénzküldés tranzakció adatait. A Barion által adott válaszban látható, hogy minden olyan mező, amelyet a pénzküldés funkció nem használ (bolti azonosító, termékek, borravalók) mind null értékkel kerül küldésre. A Status mezőben található "2" érték azt jelzi, hogy ez egy sikeresen végbement tranzakció.

Bemenet

{
    TransactionId: "ea42f3ae-a6aa-449e-a6f8-e681b7fad966"
}

Kimenet

{
    "TransactionId": "ea42f3ae-a6aa-449e-a6f8-e681b7fad966",
    "Amount": 1000,
    "Status": 2,
    "StartTime": "2014-10-28T14:18:46.273",
    "EndTime": "2014-10-28T14:18:46.273",
    "RelatedId": null,
    "ApplicationId": null,
    "ShopTransactionId": null,
    "Products": null,
    "Error": null,
    "TipOption": null,
    "To": {
        "LoginName": "somebody@barion.com",
        "FirstName": null,
        "LastName": null,
        "OrganizationName": null
    },
    "ShopName": null
}

Vásárlás tranzakció

Az alábbi példában lekérdezzük egy webshopban indított online vásárlási tranzakció adatait. A Status mezőben látható "3" érték jelzi, hogy ez a tranzakció még folyamatban van.

Bemenet

{
    TransactionId: "d2645361-32f9-4efa-9497-e536c8d92489"
}

Kimenet

{
    "TransactionId": "d2645361-32f9-4efa-9497-e536c8d92489",
    "Amount": 2800,
    "Status": 3,
    "StartTime": "2014-10-28T12:42:58.973",
    "EndTime": "2014-10-28T14:26:51.9162385Z",
    "RelatedId": null,
    "ApplicationId": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
    "ShopTransactionId": "ywbgjoq8wwcf7saa",
    "Products": [
        {
            "Name": "Jumping All Over The World",
            "Description": "Scooter: Jumping All Over The World - Digital Album, 2007",
            "Quantity": 1,
            "Unit": "db",
            "Price": 2800,
            "SKU": "SCO021"
        }
    ],
    "Error": null,
    "TipOption": {
        "DefaultValues": true,
        "ThereIsTip": true,
        "TipIncluded": false,
        "FirstOption": 10,
        "SecondOption": 20,
        "ThirdOption": 30
    },
    "To": {
        "LoginName": "lemezbolt@example.com",
        "FirstName": null,
        "LastName": null,
        "OrganizationName": "Online Lemezbolt 2014 Kft."
    },
    "ShopName": "Online Lemezbolt 2014"
}


Sikertelen hívás

Érvénytelen paraméter

Az alábbi példában egy sikertelen lekérést láthatunk. A megadott tranzakcióazonosító nem érvényes GUID.

Bemenet

{
    TransactionId: "TRANS0001"
}

Kimenet

{
    "TransactionId": null,
    "Amount": 0,
    "Status": 0,
    "StartTime": null,
    "EndTime": null,
    "RelatedId": null,
    "ApplicationId": null,
    "ShopTransactionId": null,
    "Products": null,
    "Error": {
        "ErrorNumber": 1101,
        "ErrorMessage": "Not Valid TransactionId",
        "Details": null
    },
    "TipOption": null,
    "To": null,
    "ShopName": null
}

Nem létező tranzakció

Az alábbi példa egy szintén sikertelen lekérést mutat. Helyes GUID formátumú tranzakciós azonosítót küldtünk, ami azonban nem létezik a Barionban.

Bemenet

{
    TransactionId: "a2245331-32f9-4efa-9497-e536c8cf4981"
}

Kimenet

{
    "TransactionId": null,
    "Amount": 0,
    "Status": 0,
    "StartTime": null,
    "EndTime": null,
    "RelatedId": null,
    "ApplicationId": null,
    "ShopTransactionId": null,
    "Products": null,
    "Error": {
        "ErrorNumber": 1102,
        "ErrorMessage": "Not Existing TransactionId",
        "Details": null
    },
    "TipOption": null,
    "To": null,
    "ShopName": null
}


Bolti vásárlás borravalóval

Bemenet

{
    TransactionId: "ce3779bc-399d-4918-9e66-49ba7f9c7bec"
}

Kimenet

{
    "TransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
    "Amount": 1500,
    "Status": 3,
    "StartTime": "2014-10-28T12:42:58.973",
    "EndTime": "2014-10-28T14:26:51.9162385Z",
    "RelatedId": null,
    "ApplicationId": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
    "ShopTransactionId": "ywbgjoq8wwcf7saa",
    "Products": [
        {
            "Name": "Jumping All Over The World",
            "Description": "Scooter: Jumping All Over The World - Digital Album, 2007",
            "Quantity": 1,
            "Unit": "db",
            "Price": 1500,
            "SKU": "SCO021"
        }
    ],
    "Error": null,
    "TipOption": {
        "DefaultValues": true,
        "ThereIsTip": true,
        "TipIncluded": false,
        "FirstOption": 10,
        "SecondOption": 20,
        "ThirdOption": 30
    },
    "To": {
        "LoginName": "lemezbolt@example.com",
        "FirstName": null,
        "LastName": null,
        "OrganizationName": "Online Lemezbolt 2014 Kft."
    },
    "ShopName": "Online Lemezbolt 2014",
    "TransactionDetails" :{
        "TransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
        "Time": "2014-10-28T15:12:51.329",
        "Amount": -1500,
        "FromName": "Szabó Csilla",
        "FromEmailAddress": "szabocsilla@gmail.com",
        "ToEmailAddress": "lemezbolt@example.com",
        "ToName": "Online Lemezbolt 2014",
        "FromBalance": 5500,
        "Comment": null,
        "ComissionBySender": null,
        "Currency": "Forint",
        "TransactionType": 1, // Fizetés típusú tranzakció
        "RelatedTransactionId": null,
        "Products": [],
        "ShopName": "Lajos boltja",
        "IsParkingTransaction": false,
        "ShopGuid": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
        "AmountWithTip": 1800,
        "RelatedTransactions": [
            {
                "TransactionId": "03e61e3c-486d-4e66-9795-6175257a89d1",
                "Time": "2014-11-05T09:05:44.21",
                "Amount": -300,
                "FromName": "Szabó Csilla",
                "FromEmailAddress": "szabocsilla@gmail.com",
                "ToEmailAddress": "lemezbolt@example.com",
                "ToName": "Online Lemezbolt 2014 Kft",
                "FromBalance": 4000,
                "Comment": null,
                "ComissionBySender": null,
                "Currency": "Forint",
                "TransactionType": 18, // Borravaló típusú tranzakció
                "RelatedTransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
                "Products": null,
                "ShopName": "Lajos boltja",
                "IsParkingTransaction": false,
                "ShopGuid": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
                "AmountWithTip": 300,
                "RelatedTransactions": []
            },
            {
                "TransactionId": "f72d0d34-1620-4c7f-8f2d-180f5ecfcc1b",
                "Time": "2014-11-05T09:05:44.21",
                "Amount": 50,
                "FromName": "Online Lemezbolt 2014 Kft",
                "FromEmailAddress": "lemezbolt@example.com",
                "ToEmailAddress": null,
                "ToName": "Barion",
                "FromBalance": 6000,
                "Comment": null,
                "ComissionBySender": null,
                "Currency": "Forint",
                "TransactionType": 0, // Jutalék típusú tranzakció
                "RelatedTransactionId": "ce3779bc-399d-4918-9e66-49ba7f9c7bec",
                "Products": null,
                "ShopName": "",
                "IsParkingTransaction": false,
                "ShopGuid": "c82e38cc-6de0-41a1-8816-ee70c37f3c22",
                "AmountWithTip": 50,
                "RelatedTransactions": []
            }
        ]
    }
}