Az összes fizetőeszköz-regisztráció érvénytelenítése

Működés
Használja az CancelAllPaymentRegistrations funkciót egy vásárló összes fizetőeszköz-regisztrációjának érvénytelenítéséhez egy adott fizetési szolgáltatónál. Az API hívásban adja át a bolt és a fizetési szolgáltató nevét, illetve a vásárló egyedi azonosítóját. A kérésre adott válasz (ResultData) tartalmazza a sikeresen és sikertelenül érvénytelenített fizetőeszköz-regisztrációkhoz tartozó referencia tranzakciókat.
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.
​Próbálja ki ezt a funkciót!​
Az API kérés paraméterei
Az API kérés általános információi
Művelet
HTTP kérés
Adatok
CancelAllPaymentRegistrations
POST
method=CancelAllPaymentRegistrations

json={JSON encode-olt paraméterek}
Paraméterek
Paraméter
Típus
Érték
Leírás
StoreName
string
A BIG FISH Payment Gateway szerződésben kerül meghatározásra.
Rendszerünkben tárolt egyedi bolt azonosító.
ProviderName
string
Barion2
Borgun2 (RPG)
GP (Global Payments)
OTPSimple (SimplePay)
PayPalRest
PayURest
Saferpay (Worldline)
A tranzakcióhoz tartozó fizetési szolgáltató.
UserId
string
szabadon választott

(kivéve e-mail címek és személyes adatok)
A fizetőeszköz-regisztrációhoz használt vásárló-azonosító a kereskedő áruházában.
Mintakód
Az összes fizetőeszköz regisztrációjának érvénytelenítése CancelAllPaymentRegistrations 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 'CancelAllPaymentRegistrations | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=CancelAllPaymentRegistrations' \
  --data 'json=
    {
        "StoreName":"sdk_test",
        "ProviderName":"OTPSimple",
        "UserId":"BF-TEST-USER-REG-DEL"
    }'
API válasz paraméterek
A CancelAllPaymentRegistrations 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
ResultCode
string
Az API kérés eredménye lehet:
SUCCESSFUL
Sikertelen érvénytelenítés esetén:
InactiveStore
InactiveProvider
MissingParameter
MissingRemoteAddress
UnauthorizedAccess
UnauthorizedRemoteAddress
UnknownProvider
UnknownStore
WrongApikey
Illetve további szolgáltató specifikus eredménykódok.
SUCCESSFUL: az API kérés sikeres.
​ResultData​
JSON object
egyedi értékek
Tartalmazza a sikeresen és sikertelenül érvénytelenített regisztrációkhoz tartozó referencia tranzakciókat.
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.
A ResultData paraméter elemei
Paraméter
Típus
Érték
Leírás
TransactionId
string

(32 karakter)
md5 hash
Az érvénytelenítésre kerülő fizetőeszköz-regisztrációhoz tartozó referencia tranzakció azonosító (a BIG FISH Payment Gateway rendszerében).
Message
string
SUCCESSFUL
Egyéb szöveges hibaüzenet
Az adott fizetőeszköz-regisztráció érvénytelenítésének eredményét írja le.
Mintakód
Az összes fizetőeszköz-regisztráció sikeres érvénytelenítésére adott válasz:
{
    "ResultCode":"SUCCESSFUL",
    "ResultData":
    [
        {
            "TransactionId":"35583f7e0dd52499c16835acdbff6bd4",
            "Message":"SUCCESSFUL"
        },
        {
            "TransactionId":"8e0c1de0aa4468d94223e368ed704c98",
            "Message":"SUCCESSFUL"
        }
    ],
    "ResultMessage":null,
    "ResponseId": "3202109280600047722"
}

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

Paraméter	Típus	Érték	Leírás
`StoreName`	string	A BIG FISH Payment Gateway szerződésben kerül meghatározásra.	Rendszerünkben tárolt egyedi bolt azonosító.
`ProviderName`	string	Barion2 Borgun2 (RPG) GP (Global Payments) OTPSimple (SimplePay) PayPalRest PayURest Saferpay (Worldline)	A tranzakcióhoz tartozó fizetési szolgáltató.
`UserId`	string	szabadon választott (kivéve e-mail címek és személyes adatok)	A fizetőeszköz-regisztrációhoz használt vásárló-azonosító a kereskedő áruházában.

Paraméter	Típus	Érték	Leírás
`ResultCode`	string	Az API kérés eredménye lehet: SUCCESSFUL Sikertelen érvénytelenítés esetén: InactiveStore InactiveProvider MissingParameter MissingRemoteAddress UnauthorizedAccess UnauthorizedRemoteAddress UnknownProvider UnknownStore WrongApikey Illetve további szolgáltató specifikus eredménykódok.	SUCCESSFUL: az API kérés sikeres.
`ResultData`	JSON object	egyedi értékek	Tartalmazza a sikeresen és sikertelenül érvénytelenített regisztrációkhoz tartozó referencia tranzakciókat.
`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.

Paraméter	Típus	Érték	Leírás
`TransactionId`	string (32 karakter)	md5 hash	Az érvénytelenítésre kerülő fizetőeszköz-regisztrációhoz tartozó referencia tranzakció azonosító (a BIG FISH Payment Gateway rendszerében).
`Message`	string	SUCCESSFUL Egyéb szöveges hibaüzenet	Az adott fizetőeszköz-regisztráció érvénytelenítésének eredményét írja le.

Last modified 27d ago