Fizetési hivatkozás részletes adatainak lekérdezése

Működés
Használja a PaymentLinkDetails funkciót egy fizetési hivatkozás adatainak lekérdezéséhez. A lekérdezett válasz tartalmazza az adott fizetési hivatkozás és a hivatkozáshoz tartozó tranzakció adatait is.
Egy adott fizetési hivatkozáshoz több tranzakció is tartozhat, a tranzakciók közül viszont csak egy lehet sikeres.
Egy többször felhasználható fizetési hivatkozáshoz több sikeres tranzakció is tartozhat, ilyen esetben a sikeres tranzakciók a RelatedTransactions paraméterben kerülnek felsorolásra.
​Próbálja ki ezt a funkciót!​
API kérés paraméterek
Az API kérés általános információi
Művelet
HTTP kérés
Adatok
PaymentLinkDetails
POST
method=PaymentLinkDetails

json={JSON encode-olt paraméterek}
Az API kérésekhez kapcsolódó paramétereket két táblázatba soroljuk fel a könnyebb átláthatóság kedvéért. Természetesen az egyes paraméterek megjelenhetnek ugyanabban az API kérésben.
Az API paraméterek felosztása a következő:
kötelező paraméterek
opcionális paraméterek
Kötelező paraméterek
Paraméter
Típus
Érték
Leírás
PaymentLinkName
string

(35 karakter)
egyedi értékek
A fizetési hivatkozás egyedi azonosítója a BIG FISH Payment Gateway rendszerében.
Opcionális paraméterek
Paraméter
Típus
Érték
Leírás
GetInfoData
boolean
false
true
Jelzi, hogy a PaymentLinkDetails hívás során, az adott vásárlásra vonatkozó Info adatok is visszaadásra kerüljenek vagy nem.
Mintakód
Fizetési hivatkozás adatainak lekérdezése PaymentLinkDetails kérés használatával:
curl --url 'https://system-test.paymentgateway.hu/api/payment/' \
  --user 'sdk_test:86af3-80e4f-f8228-9498f-910ad' \
  --user-agent 'PaymentLinkDetails | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=PaymentLinkDetails' \
  --data 'json=
    {
        "PaymentLinkName":"pl_d6b8323abb1c839a8cd6434c67bbbbef",
        "GetInfoData":false
    }'
API válasz paraméterek
A PaymentLinkDetails kérést 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
Az objektum tartalmazza a fizetési hivatkozás alap adatait (melyeket a PaymentLinkCreate hívásra adott válasz is tartalmaz).
RelatedTransactions
JSON object
egyedi értékek
Az objektum tartalmazza az adott fizetési hivatkozáshoz tartozó további tranzakciókat.
InfoData
JSON object
egyedi értékek
Az objektum tartalmazza a fizetési hivatkozás létrehozása során megadott Info adatokat.
ResultCode
string
SUCCESSFUL
Hiba esetén a következő eredménykódok jelölik a hiba okát:
InactiveStore
MissingParameter
MissingRemoteAddress
UnauthorizedAccess
UnauthorizedRemoteAddress
UknownPaymentLink
UnknownStore
WrongApikey
Jelzi a lekérdezés eredményét.
ResultMessage
string
leírás
Az egyes ResultCode értékek szöveges magyarázata.
ResponseId
integer
egyedi értékek
A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.
Mintakód
A PaymentLinkDetails kérésre adott válasz formázás után:
{
    "CommonData":
    {
        "PaymentLinkUrl":"https://system-test.paymentgateway.hu/PaymentLink/pl_d6b8323abb1c839a8cd6434c67bbbbef",
        "PaymentLinkQR":"https://system-test.paymentgateway.hu/PaymentQR/pl_d6b8323abb1c839a8cd6434c67bbbbef.png",
        "ResultCode":"SUCCESSFUL",
        "ResultMessage":null,
        "PaymentLinkName":"pl_d6b8323abb1c839a8cd6434c67bbbbef",
        "ProviderName":"Borgun2",
        "Amount":"100",
        "Currency":"HUF",
        "Language":"HU",
        "OrderId":"BF-TEST-ORDER",
        "UserId":"BF-TEST-USER",
        "AutoCommit":"1",
        "ExpirationTime":null,
        "NotificationUrl":null,
        "NotificationEmail":"[email protected]",
        "EmailNotificationOnlySuccess":"0",
        "EmailNotificationTime":null,
        "Extra":null,
        "Status":"PENDING",
        "Created":"2017-11-20 14:43:31",
        "LastModified":"2017-11-20 14:43:31",
        "ResponseId": "3202109280600047727"
    },
    "RelatedTransactions": [],
    "InfoData": null,
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": null,
    "ResponseId": "3202109280600047727"
}

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

Paraméter	Típus	Érték	Leírás
`PaymentLinkName`	string (35 karakter)	egyedi értékek	A fizetési hivatkozás egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Paraméter	Típus	Érték	Leírás
`GetInfoData`	boolean	false true	Jelzi, hogy a `PaymentLinkDetails` hívás során, az adott vásárlásra vonatkozó Info adatok is visszaadásra kerüljenek vagy nem.

Paraméter	Típus	Érték	Leírás
`CommonData`	JSON object	egyedi értékek	Az objektum tartalmazza a fizetési hivatkozás alap adatait (melyeket a `PaymentLinkCreate` hívásra adott válasz is tartalmaz).
`RelatedTransactions`	JSON object	egyedi értékek	Az objektum tartalmazza az adott fizetési hivatkozáshoz tartozó további tranzakciókat.
`InfoData`	JSON object	egyedi értékek	Az objektum tartalmazza a fizetési hivatkozás létrehozása során megadott `Info` adatokat.
`ResultCode`	string	SUCCESSFUL Hiba esetén a következő eredménykódok jelölik a hiba okát: InactiveStore MissingParameter MissingRemoteAddress UnauthorizedAccess UnauthorizedRemoteAddress UknownPaymentLink UnknownStore WrongApikey	Jelzi a lekérdezés eredményét.
`ResultMessage`	string	leírás	Az egyes `ResultCode` értékek szöveges magyarázata.
`ResponseId`	integer	egyedi értékek	A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Fizetési hivatkozás létrehozása

Fizetési hivatkozás érvénytelenítése

Last modified 27d ago