Search
K
Links

Fizetőeszköz-regisztráció érvénytelenítése

Működés

Használja a CancelPaymentRegistration funkciót egy fizetőeszköz regisztrációjának érvénytelenítéséhez. Az API hívásban adja át az érvényteleníteni kívánt regisztrációhoz tartozó referencia tranzakció azonosítót. Egy érvénytelenített regisztrációjú fizetőeszközzel nem lehet további rákövetkező fizetéseket (CIT, MIT), illetve kifizetést (PayOut) indítani, ehhez az adott fizetőeszköz ismételt regisztrációja szükséges.

Az API kérés paraméterei

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

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

Paraméterek

Paraméter
Típus
Érték
Leírás
TransactionId
string (32 karakter)
md5 hash
Az érvényteleníteni kívánt regisztrációhoz tartozó referencia tranzakció azonosító (a BIG FISH Payment Gateway rendszerében).

Mintakód

Fizetőeszköz regisztrációjának érvénytelenítése CancelPaymentRegistration 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 'CancelPaymentRegistration | merchant-store.com | PHP | 7.3.0' \
--request 'POST' \
--data 'method=CancelPaymentRegistration' \
--data 'json=
{
"TransactionId":"5a1871e916037166868bf6c303cb7f64"
}'

API válasz paraméterek

A CancelPaymentRegistration 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)
md5 hash
Az érvényteleníteni kívánt regisztrációhoz tartozó referencia tranzakció azonosító (a BIG FISH Payment Gateway rendszerében).
ResultCode
string
Sikeres érvénytelenítés:
  • SUCCESSFUL
Sikertelen érvénytelenítés esetén:
  • InactiveStore
  • InactiveProvider
  • MissingParameter
  • MissingRemoteAddress
  • UnauthorizedAccess
  • UnauthorizedRemoteAddress
  • UnknownStore
  • UnknownTransaction
  • WrongApikey
Illetve további szolgáltató specifikus eredménykódok.
Jelzi a regisztráció érvénytelenítés eredményét.
Sikertelen érvénytelenítés esetén a paraméter értéke jelzi a hiba oká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 fizetőeszköz-regisztráció sikeres érvénytelenítésére adott válasz:
{
"TransactionId":"5a1871e916037166868bf6c303cb7f64",
"ResultCode":"SUCCESSFUL",
"ResultMessage":null,
"ResponseId": "3202109280600047721"
}