Tranzakció érvénytelenítése (Cancel)

Működés

Használja a Cancel hívást a tranzakció érvénytelenítéséhez. Tranzakció érvénytelenítésére mindaddig lehetőség van, amíg a tranzakció PENDING, vagy OPEN státuszban van. A sikeres érvénytelenítés hatására a tranzakció CANCELED státuszba kerül, így innentől már sikeres tranzakció létrehozása nem lehetséges.

Az érvénytelenítés művelet jelenleg a következő fizetési szolgáltatók esetén érhető el:

• Raiffeisen Pay

• SimplePay

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

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

API kérés paraméterek

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.

Mintakód

A tranzakció érvénytelenítése Cancel használatával:

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

API válasz paraméterek

A Cancel 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
TransactionId	string	32 karakter hosszú md5 hash	A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
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 WrongTransactionStatus (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.
ResponseId	integer	egyedi értékek	A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

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

{
    "TransactionId": "b8156ec464a00c34b947a1aac4891e0d",
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": null,
    "ResponseId": "3382412101354326635"
}