Tranzakció eredményének lekérdezése (Result)

Működés

Használja a Result hívást a tranzakció eredményének lekérdezéséhez. A fizetés után rendszerünk visszairányítja a vásárlót az áruházba, úgy, hogy meghívja azt a ResponseUrl-t, amit az inicializáció (Init) során adott meg a kereskedő oldala. Miután rendszerünk meghívja a ResponseUrl-t, a kereskedő oldala elindíthatja a Result hívást.

Result hívás indításához szüksége lesz az adott tranzakció azonosítójára. Ezért a rendszerünkből érkező ResponseUrl hívás kiegészül a TransactionId GET paraméterrel, amely az adott tranzakció azonosítót biztosítja.

Fontos, hogy minden rendszerünkből érkező ResponseUrl hívás után indítson egy Result hívást, a vásárlói munkamenettől függetlenül. Ennek oka, hogy előfordulhat, hogy a ResponseUrl hívásra később, aszinkron módon, a háttérben kerül sor.

Rendszerünk aszinkron módon elindítja a NotificationUrl hívást, abban az esetben, ha beállt az adott tranzakció végstátusza. A NotificationUrl az inicializáció (Init) során kötelezően átadandó URL cím. Itt is fontos, hogy minden rendszerünkből érkező NotificationUrl hívás után indítson egy Result hívást.

Rendszerünk a Result hívás hatására értesül arról, hogy a kereskedő oldala megkapta a tranzakció eredményét. Ezért amennyiben a Result hívásra nem kerül sor, a tranzakció rendszerünkben a "megválaszolhatatlan" állapotot veszi fel.

Próbálja ki ezt a funkciót!

További részletekért a NotificationUrl használatáról látogassa meg a következő hivatkozást: URL Értesítés

A tranzakció állapotairól a rendszerünkben pedig a következő oldalon olvashat további információkat: Tranzakció Állapotok

Figyeljen arra, hogy Result kérést kizárólag ResponseUrl vagy NotificationUrl hívások hatására indítson. A kereskedő rendszeréből indokolatlanul, vagy ütemezett módon Result kérést indítani tilos!

Az API kérés általános információi

Művelet
HTTP kérés
Adatok

Result

POST

method=Result json={JSON encode-olt paraméterek}

API kérés paraméterek

A Result kérés egy (kötelező) paraméterrel rendelkezik

Paraméter
Típus
Érték
Leírás

TransactionId

string (32 karakter)

32 karakter hosszú md5 hash

A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

Tranzakció eredményének lekérése Result használatával

curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
  --user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
  --user-agent 'Result | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=Result' \
  --data 'json=
    {
        "TransactionId":"992c8e75435e6d4dfdf6415f0714cae8"
    }'

API válasz paraméterek

A Result kérés eredményét JSON formában válaszoljuk meg. A válasz a következő paramétereket tartalmazza:

Paraméter
Típus
Érték
Leírás

StoreName

string

egyedi értékek

Rendszerünkben tárolt egyedi boltazonosító.

ProviderName

string

egyedi értékek

A tranzakcióhoz kiválasztott fizetési szolgáltató.

TransactionId

string

32 karakter hosszú md5 hash

A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.

ResultCode

string

A tranzakció státusza lehet:

  • SUCCESSFUL

  • PENDING

  • OPEN

  • ERROR

  • CANCELED

  • TIMEOUT

Hiba esetén a következő eredménykódok jelölik a hiba okát:

  • InactiveStore

  • MissingParameter

  • MissingRemoteAddress

  • UnauthorizedAccess

  • UnauthorizedRemoteAddress

  • UnknownStore

  • UnknownTransaction

  • WrongApikey

ResultMessage

string

leírás

Az egyes ResultCode értékek szöveges magyarázata.

Anum

string

egyedi értékek

A tranzakció engedélyszáma a fizetési szolgáltató rendszerében.

(Csak bizonyos szolgáltatók esetén.)

Amount

number

egyedi értékek

A tranzakció bruttó végösszege.

(Az összeg amit a vásárló kifizetett.)

Currency

string

(3 karakter)

  • HUF

  • EUR

  • USD

  • ...

A tranzakció devizaneme.

OrderId

string

egyedi értékek (kivéve e-mail címek, illetve személyes adatok)

A megrendelés azonosítója a kereskedő áruházában.

(Az inicializáció során átadott OrderId.)

UserId

string

egyedi értékek

(kivéve e-mail címek, illetve személyes adatok)

A vásárló azonosítója a kereskedő áruházában.

(Az inicializáció során átadott UserId.)

Language

string

(2 karakter)

  • HU (alapért.)

  • EN

  • DE

  • ...

(ISO 639-1 alapján)

A fizetési felület nyelve.

ProviderTransactionId

string

egyedi értékek

A tranzakció azonosítója a fizetési szolgáltató rendszerében.

AutoCommit

string

  • “false”

Jelzi, hogy a bank később hajtja végre a tranzakciót.

(Az inicializáció során beállított AutoCommit értéke.)

CommitState

string

  • PENDING

  • APPROVED

  • DECLINED

Kétlépcsős tranzakció esetén jelzi a tranzakciós összeg állapotát.

• PENDING: az összeg zárolásra került, de még terhelésre vár (tranzakció lezárással)

• APPROVED: a végleges összeg beterhelése megtörtént

• DECLINED: a zárolt összeg feloldásra került (nem történt terhelés)

PaywallPaymentName

string (36 karakter)

  • null

  • UUID

A tranzakció PayWall azonosítója (kizárólag a PayWall segítségével indított fizetések esetén).

PaywallRecurringPaymentEnabled

string

  • "true"

  • "false"

Jelzi a vásárló hozzájárulását, hogy a kereskedő a jövőben az adott tranzakcióra hivatkozva újabb, ismétlődő tranzakciókat indíthasson (kizárólag a PayWall segítségével indított fizetések esetén).

PaymentRegistrationType

string

  • CIT

Jelzi a fizetési regisztráció típusát.

SzepPocket

string

  • null

A tranzakció inicializálása (Init) során megadott zsebazonosító (SZÉP Kártyás fizetés esetén).

ProviderResultCode

string

egyedi értékek, melyek csak az alábbi fizetési szolgáltatóktól származhatnak (szolgáltató és hozzá tartozó kód párosként felsorolva):

  • Barion2 (ErrorCode)

  • Borgun2 (ActionCode)

  • GP (PRCODE)

  • KHB

  • OTPSimple (resultCode / errorCodes)

  • PayURest (cardResponseCode)

  • Saferpay (ErrorName)

A fizetési szolgáltató rendszeréből származó elsődleges eredmény- vagy hibakód.

ProviderResultCode2

string

egyedi értékek, melyek csak az alábbi fizetési szolgáltatóktól származhatnak (szolgáltató és hozzá tartozó kód párosként felsorolva):

  • GP (SRCODE)

  • KHB

  • Saferpay (ProcessorResult)

A fizetési szolgáltató rendszeréből származó másodlagos eredmény- vagy hibakód.

PaymentLinkName

string (35 karakter)

egyedi értékek

A fizetési hivatkozás azonosítója a BIG FISH Payment Gateway rendszerében (amennyiben a tranzakció PayLink segítségével jött létre).

Created

string

dátum

A tranzakció létrehozásának ideje.

ResponseId

integer

egyedi értékek

A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

A fenti Result kérésre adott válasz:

{
    "StoreName": "sdk_test",
    "ProviderName": "Borgun2",
    "TransactionId": "992c8e75435e6d4dfdf6415f0714cae8",
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": "Sikeres tranzakció",
    "Anum": "006761",
    "Amount": "100",
    "Currency": "HUF",
    "OrderId": "BF-TEST-ORDER",
    "UserId": "BF-TEST-USER",
    "Language": "HU",
    "ProviderTransactionId": "tr_tzftXkC-fcwaVPiAVVNgotmIhY_QXydL",
    "AutoCommit": "true",
    "CommitState": "APPROVED",
    "PaywallPaymentName": null,
    "PaywallRecurringPaymentEnabled": "false",
    "PaymentRegistrationType": null,
    "SzepPocket": null,
    "ProviderResultCode": "000",
    "ProviderResultCode2": null,
    "PaymentLinkName": null,
    "Created": "2020-03-14 11:19:07",
    "ResponseId": "3202109280600047703"
}

Last updated