Payment-GetTransactionState-v2

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ó állapotának lekérdezése

GET /v2/Payment/GetTransactionState

Ez a metódus egy tranzakció adatainak lekérésére szolgál. Csak a tranzakcióban résztvevő felek, és összetett fizetés esetén a fizetés kezdeményezője érheti el egy tranzakció adatait.

Bemenet

Figyelem! Az alábbi API hívási módja megváltozott, de az eddigi működési mód továbbra is működik, csak már nem ajánlott! A változás után a bolt tulajdonosának Username/Password/POSId hármasa helyett, elég lesz egy szintén titkos, de a fizetés lebonyolításán kívül semmi másra fel nem hatalmazó POSKey megadása. A POSKey használata növeli a biztonságot, és olyan boltokban különösen előnyös, ahol a bolt tulajdonosa nem kívánja megadni Username/Password párosát a boltot üzemeltető műszaki szolgáltatónak, vagy személyzetnek.

Élesítés: Teszt és Éles rendszerben is elérhető.

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
POSKey Guid Kötelező nincs nincs A Barion által generált titkos azonosító, amely fizetések indítására felhatalmaz, de a Barion tárcához hozáférést nem biztosít. 999FFDDA-04FF-333F-CCCC-345FCB555FFC
TransactionId GUID Kötelező nincs nincs A tranzakció Barionban található egyedi azonosítója. d2645361-32f9-4efa-9497-e536c8d92489

Kimenet

Sikeres

Mező Típus Leírás Formátum / Példa
TransactionId GUID Egyértelműen azonosítja a tranzakciót a Barion rendszerben. d2645361-32f9-4efa-9497-e536c8d92489
TransactionTime DateTime A tranzakció megtörténtének időpontja. 2015-02-26T14:22:40.312
Total decimal A tranzakció összege. 3400
Currency string A tranzakció devizaneme. HUF
Payer UserCredentials A tranzakciót fizető felhasználó. Próba Fiók
Payee UserCredentials A tranzakciót fogadó felhasználó. Teszt Név
Comment String A tranzakció megjegyzése. Vásárlás megjegyzés
Status String Megadja a lekérdezett tranzakciós státuszát. Prepared
TransactionType String A tranzakció típusa. Shop
Items Item[] A tranzakcióhoz kapcsolódó terméklista. Item
POSId Guid A bolt azonosítója. d2645361-32f9-4efa-9497-e536c8d92489
POSTransactionId String A trazakció külső azonosítója. "fa-01"
FraudRiskScore int A fizetéshez kapcsolódó fraud kockázat százalékosan meghatározva(0-100). 10
CallbackUrl string A fizetéshez kapcsolódó visszahívási URL, ahova a fizetés után a Barion rendszere visszahívást intéz.
RedirectUrl string A fizetéshez kapcsolódó átirányítási URL, ahova a felhasználó a sikeres fizetés után átirányításra kerül.

Sikertelen

Hiba esetén a válasz egy hibalistát ad vissza. Ebben megtalálhatóak az előforduló hibák. A lista formátuma:

{
    Errors: [
        {
            ErrorCode: "",
            Title: "",
            Description: ""
        }
    ]
}

Hibakódok

Hiba kódja Hiba leírása

Példák

Sikeres hívás

Vásárlás tranzakció

Bemenet

https://api.barion.com/v2/Payment/GetTransactionState?POSKey=999FFDDA-04FF-333F-CCCC-345FCB555FFC&TransactionId=29d5c840-1f6b-4f9d-bcb6-e1ed0fe8cde3

Kimenet

{
    "TransactionId": "29d5c8401f6b4f9dbcb6e1ed0fe8cde3",
    "TransactionTime": "2015-03-03T15:23:41.153",
    "Total": 200,
    "Currency": "HUF",
    "Payer": null,
    "Payee": {
       "Name": {
          "LoginName": "payee@barion.com",
          "FirstName": " Payee",
          "LastName": "Test",
          "OrganizationName": null
       },
       "Email": "payee@barion.com"
    },
    "Status": "Prepared"
    "Comment": null,
    "TransactionType": "Unspecified",
    "Items": [
        {
            "Name": "Tej",
            "Description": "Házi tehéntej",
            "Quantity": 2,
            "Unit": "liter",
            "UnitPrice": 100,
            "ItemTOtal": 200,
            "SKU": null
        }],
    "POSId": "29d5c8401f6b4f9dbcb6e1ed0fe8cde3",
    "POSTransactionId": "fa-01-01",
    "FraudRiskScore": 10,
    "CallbackUrl": "https://webshop.example.com/BarionExamplePayment",
    "RedirectUrl": "https://webshop.example.com/PaymentResultExample?paymentId=edd81a0a35b0439f91803933d5b3f5ad",
    "Errors": [ ]
}

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

https://api.barion.com/v2/Payment/GetTransactionState?POSKey=999FFDDA-04FF-333F-CCCC-345FCB555FFC

Kimenet

{
    "Errors": [
        {
            "ErrorCode": "ModelValidationError",
            "Title": "Model Validation Error",
            "Description": "The TransactionId field is required. "
        }
    ]
}

Nem létező tranzakció

Bemenet

api.barion.com/v2/Payment/GetPaymentState?POSKey=999FFDDA-04FF-333F-CCCC-345FCB555FFC&PaymentId=c1ea49ab-41c1-4c20-bc58-787a740188ab

Kimenet

{
    "Errors": [
        {
            "ErrorCode": "NotExistingPaymentId",
            "Title": "The given transaction id is invalid",
            "Description": "The given transaction id(c1ea49ab-41c1-4c20-bc58-787a740188ab) is invalid!"
        }
    ]
}