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

Fizetés állapotának lekérdezése

GET /v2/Payment/GetPaymentState

Az alábbi hívással lekérdezhetők egy fizetés, és a hozzá tartozó tranzakciók adatai a fizetés egyedi azonosítója alapján.

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.

Ezt a lekérdezést csak a fizetést kezdeményező fél hívhatja meg.

Bemenet

A fizetést kezdeményező fél adatai mellett a fizetés Barionban található egyedi azonosítóját kell megadni. Ezt a bolt a fizetés kezdeményezésekor kapja meg.

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.

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
PaymentId Guid Kötelező nincs nincs A fizetés Barionban található egyedi azonosítója. d2645361-32f9-4efa-9497-e536c8d92489

Kimenet

Sikeres

Mező Típus Leírás Formátum / Példa
PaymentId Guid A fizetés Barion rendszerben lévő azonosítója. d2645361-32f9-4efa-9497-e536c8d92489
PaymentRequestId string A fizetés a kezdeményező rendszerben lévő azonosítója. fa-01
POSId Guid A fizetés a kezdeményező rendszerben lévő azonosítója. 40759cb0-3eda-41a6-ba84-26a46a5c55f2
POSName string A bolt neve. Example shop
POSOwnerEmail string A bolt tulajdonosának email címe. example@shop.hu
Status PaymentStatus A fizetés státusza. Requested
PaymentType PaymentType A fizetés típusa. Lehet Immediate, és Reservation. Immediate
FundingSource FundingSourceType Befejezett fizetés esetén a fizetés eszköze. FundingSourceType
FundingInformation FundingInformation Bankkártyás fizetés esetén a kártya és a banki tranzakció adatai. FundingInformation
AllowedFundingSources string[] A bolt által megadott fizetési módok listája. [ "Barion" ]
GuestCheckout bool Támogatja-e a fizetés az anonim vásárlást? true
CreatedAt DateTime A fizetés kezdeményezésének időpontja. 2015-02-26T14:22:40.312
ValidUntil DateTime A fizetés lejártának időpontja. 2015-02-26T14:22:40.312
CompletedAt DateTime A fizetés végének időpontja. 2015-02-26T14:22:40.312
ReservedUntil DateTime Befoglalásos tranzakció esetén a befoglalás végének időpontja. Eddig lehet végrehajtani a fizetést, ezután az elévül. 2015-02-26T14:22:40.312
Transactions GatewayTransactionDetailModel A fizetéshez tartozó összes tranzakció, és azoknak részletei. GatewayTransactionDetailModel
Total decimal A fizetéshez tartozó összes tranzakció aktuális összege, függetlenül azok státuszától. 4000
Currency string A fizetés devizaneme. HUF
SuggestedLocale string A fizetés indításakor a Barion számára javasolt nyelv a felhasználói felület megjelenítésekor. hu-HU
FraudRiskScore NEW! int A fizetéshez kapcsolódó fraud kockázat százalékosan meghatározva(0-100). 10
CallbackUrl NEW! 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 NEW! 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.

Megjegyzés: A kimenetben átadott DateTime értékek UTC időzónában értendők.

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
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élda hívás

Bemenet

https://api.barion.com/v2/Payment/GetPaymentState?POSKey=999FFDDA-04FF-333F-CCCC-345FCB555FFC&PaymentId=db3f3bda-9fc8-4229-b21a-b021483a5435

Kimenet

{
    "PaymentId": "ecc2bc7a3d8147cab1f04de3dddd657f ",
    "PaymentRequestId": "TEST-01",
    "POSId": "56c5aa0ed69b40a39d89756817f83838",
    "POSName": "Barion bolt",
    "POSOwnerEmail": "example@shop.com",
    "Status": "Succeeded",
    "PaymentType": "Immediate",
    "FundingSource": "Bankcard",
    "FundingInformation": {
       "BankCard": {
            "MaskedPan": "0425",
            "BankCardType": "Visa",
            "ValidThru_Year": "2018",
            "ValidThru_Month": "11"
        },
        "AuthorizationCode": "975452"
    },
    "GuestCheckout": true,
    "CreatedAt": "2015-03-03T09:30:45.648",
    "StartedAt": null,
    "CompletedAt": "2015-03-03T09:35:45.648",
    "ValidUntil": "2015-03-03T10:30:45.648",
    "ReservedUntil": "2015-03-03T09:45:45.648",
    "SuggestedLocale": "hu-HU",
    "FraudRiskScore" : 10,
    "Transactions": [
        {
           "TransactionId": "ef01be38ad6e413eb47fbeeb6026b8aa",
           "POSTransactionId": "TEST-01-01",
           "TransactionTime": "2015-04-24T05:31:35.499",
           "Total": 500,
           "Currency": "HUF",
           "Payer": {
              "Name": {
                 "LoginName": "payer@barion.com",
                 "FirstName": " Payer",
                 "LastName": "Test",
                 "OrganizationName": null
              },
              "Email": "payer@barion.com"
           },
           "Payee": {
              "Name": {
                 "LoginName": "payee@barion.com",
                 "FirstName": " Payee",
                 "LastName": "Test",
                 "OrganizationName": null
              },
              "Email": "payee@barion.com"
           },
           "Comment": "Transaction comment",
           "Status": "Succeeded",
           "TransactionType": "CardPayment",
           "Items": [ 
           {
              "Name": "Product name",
              "Description": "product description",
              "Quantity": 5,
              "Unit": "piece",
              "UnitPrice": 500,
              "ItemTotal": 2500,
              "SKU": "SM-01"
           }],
           "RelatedId": null,
           "POSId": "56c5aa0ed69b40a39d89756817f83838"        
    ],
    "Total": 500,
    "Currency": "HUF",
    "FraudRiskScore": 10,
    "CallbackUrl": "https://webshop.example.com/BarionExamplePayment",
    "RedirectUrl": "https://webshop.example.com/PaymentResultExample?paymentId=ecc2bc7a3d8147cab1f04de3dddd657f ",
    "Errors": [ ]
}

Sikertelen hívás

Nem létező fizetés

Bemenet

https://api.barion.com/v2/Payment/GetPaymentState?POSKey=999FFDDA-04FF-333F-CCCC-345FCB555FFC&PaymentId=db3f3bda-9fc8-4229-b21a-b021483a5434

Kimenet

{
    "Errors": [
        {
            ErrorCode: "NotExistingPaymentId",
            Title: "The given transaction id is invalid",
            Description: "The given transaction id(db3f3bda-9fc8-4229-b21a-b021483a5435) is invalid!"
        }
    ]
}