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

Működés

Használja a PaymentLinkCancel funkciót egy fizetési hivatkozás érvénytelenítéséhez. Felhívjuk figyelmét, hogy kizárólag olyan fizetési hivatkozás érvényteleníthető, amelyhez még nem tartozik sikeres tranzakció és a link még érvényes, tehát nem járt le és nem lett érvénytelenítve.

Egy sikeresen érvénytelenített fizetési hivatkozás nem élesíthető újra, ezért érvénytelenítés után a fizetési hivatkozással később sem hajthatók végre újabb tranzakciók. Egy érvénytelenített fizetési hivatkozással megegyező fizetéshez újabb hivatkozás létrehozása szükséges.

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
PaymentLinkCancel	POST	method=PaymentLinkCancel json={JSON encode-olt paraméterek}

Kötelező paraméterek

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

Mintakód

Fizetési hivatkozás érvénytelenítése PaymentLinkCancel 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 'PaymentLinkCancel | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=PaymentLinkCancel' \
  --data 'json=
    {
        "PaymentLinkName":"pl_d6b8323abb1c839a8cd6434c67bbbbef"
    }'

API válasz paraméterek

A PaymentLinkCancel 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
PaymentLinkName	string (35 karakter)	egyedi értékek	A fizetési hivatkozás egyedi azonosítója a BIG FISH Payment Gateway rendszerében.
Status	string	PENDING SUCCESSFUL ERROR CANCELED TIMEOUT	A fizetési hivatkozás státusza.
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 hívá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 PaymentLinkCancel kérésre adott válasz:

{
    "PaymentLinkName":"pl_d6b8323abb1c839a8cd6434c67bbbbef",
    "Status":"CANCELED",
    "ResultCode":"SUCCESSFUL",
    "ResultMessage":"Fizetési link érvénytelenítése sikeres",
    "ResponseId": "3202109280600047728"
}