Tranzakció részletes adatainak lekérdezése (Details)

Működés

Használja a Details hívást a tranzakció részletes adatainak lekérdezéséhez. Míg a Result hívásra adott válasz csupán a tranzakció alapadatait hordozza, a Details hívás további részletes információkat is tartalmaz az adott tranzakcióról (pl. szolgáltató specifikus adatokat).

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

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

Művelet	HTTP kérés	Adatok
Details	POST	method=Details json={JSON encode-olt paraméterek}

API kérés paraméterek

A Details kérés a következő paraméterekkel rendelkezik (a TransactionId átadása kötelező)

Paraméter	Típus	Érték	Leírás
TransactionId	string	32 karakter hosszú md5 hash	A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
GetRelatedTransactions	boolean	true (alapért.) false	Olyan korábbi tranzakciók részletes adatainak lekérése, melyek OrderId paramétere megegyezik az aktuális tranzakció OrderId értékével.
GetInfoData	boolean	true false (alapért.)	Kérés a vásárlásra vonatkozó Info adatok visszaadására. (Init, InitRP vagy PaymentLinkCreate hívások során átadott vásárlási adatok esetén.)

Mintakód

A tranzakció részletes adatainak lekérése Details használatával:

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

API válasz paraméterek

Az Details 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
CommonData	JSON object	egyedi értékek	A tranzakció alapadatai. (A Result hívás során is visszaadott adatok.)
ProviderSpecificData	JSON object	egyedi értékek	Szolgáltató specifikus kiegészítő adatok.
RelatedTransactions	JSON object	egyedi értékek	Olyan korábbi tranzakciók adatai melyek OrderId paramétere megegyezik az aktuális tranzakció OrderId értékével.
InfoData	JSON object	egyedi értékek	Az Info objektum adatai.
ResultCode	string	Az API kérés eredménye lehet: SUCCESSFUL Hiba esetén a következő eredménykódok jelölik a hiba okát: InactiveStore MissingParameter MissingRemoteAddress UnauthorizedAccess UnauthorizedRemoteAddress UnknownStore UnknownTransaction WrongApikey (Továbbá a szolgáltatókra vonatkozó specifikus eredménykódok is megjelenhetnek itt.)	Jelzi az API kérés eredményét: SUCCESSFUL: az API kérés sikeres.
ResultMessage	string	leírás	Az egyes ResultCode értékek szöveges magyarázata.
ProviderName	string	egyedi értékek	A tranzakcióhoz kiválasztott fizetési szolgáltató.
ResponseId	integer	egyedi értékek	A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

A fenti Details kérésre adott válasz (formázást követően):

{
    "CommonData":
    {
        "StoreName": "sdk_test",
        "ProviderName": "Borgun2",
        "TransactionId": "a4d6f6f27f2116da21da62d705dbd7ef",
        "ResultCode": "SUCCESSFUL",
        "ResultMessage": "Sikeres tranzakció",
        "Anum": "006766",
        "Amount": "100",
        "Currency": "HUF",
        "OrderId": "BF-TEST-ORDER",
        "UserId": "BF-TEST-USER",
        "Language": "HU",
        "ProviderTransactionId": "tr_GVaydOjpVySGJycK15glvGgbLGxmCQyf",
        "AutoCommit": "false",
        "CommitState": "APPROVED",
        "Created": "2020-03-14 11:19:07",
        "ResponseId": "3202109280600047706"
    },
    "ProviderSpecificData":
    {
        ...
        "Amount": "100",
        "Currency": "HUF",
        "Language": "HU",
        "OrderId": "BF-TEST-ORDER",
        "UserId": "BF-TEST-USER",
        "ResponseUrl": "https://demo.paymentgateway.hu/response.php",
        "NotificationUrl": null,
        "MaxNotificationSendAttempts": 0,
        "NotificationSendAttempts": 0,
        "NotificationSendSuccess": 0,
        "Extra": null,
        "AutoCommit" : "0",
        "CommitState": "1",
        "HasRefund": "0",
        "Created": "2017-11-17 13:12:36",
        "LastModified": "2017-11-17 13:14:07",
        "InvoiceDate": null,
        "TransactionLogs":
        [
            ...
            {
                "logMessage": "getInitResponse(): SUCCESSFUL",
                "stamp": "2017-11-17 13:12:36"
            },
            {
                "logMessage": "Transaction initialized...",
                "stamp": "2017-11-17 13:12:36"
            }
        ],
        "GatewayPaymentPage": null,
        "ModuleName": null,
        "ModuleVersion": null,
        "StoreProviderId": "3103",
        "Error": null,
        "ResultMessage": null
    },
    "RelatedTransactions": null,
    "InfoData": null,
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": null,
    "ProviderName": "Borgun2",
    "ResponseId": "3202109280600047706"
}