Kétlépcsős tranzakció inicializálása (Init)

Működés

Használja az inicializálás (Init) funkciót egy új fizetési tranzakció kezdeményezésére. Az inicializálás során a kereskedő oldala átadja a vásárló adatait rendszerünknek. Ennek hatására rendszerünk létrehoz egy új tranzakciós rekordot a kereskedőtől kapott adatok felhasználásával. Sikeres inicializálás esetén az új rekord mellett rendszerünk létrehoz egy új tranzakció azonosítót is (TransactionId), majd visszaadja ezt az azonosítót a kereskedő oldalának.

A kétlépcsős fizetés inicializálása során figyeljen a következőkre:

• Adja át az AutoCommit paramétert "false" értékkel későbbi terhelés engedélyezéséhez.

• Használjon erős ügyfél-hitelesítést (PSD2-SCA) a vásárló adatainak átadásához. Erről a következő oldalon olvashat részletesebben: Erős ügyfél-hitelesítés (PSD2/SCA)

• Tárolja le az Init kérésre visszaadott tranzakció azonosítót, mivel később ennek segítségével hivatkozhat az adott tranzakcióra.

Próbálja ki ezt a funkciót!

Az inicializációban a fizetési szolgáltatók nem vesznek részt, ez a folyamat kizárólag a kereskedő oldala és a BIG FISH Payment Gateway rendszere között zajlik.

Mobilalkalmazás fejlesztésnél biztosítsa, hogy az inicializációra a szerver oldalon kerüljön sor. Biztonsági okokból az inicializáció nem történhet meg a mobil alkalmazásban.

API kérés paraméterek

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

Művelet	HTTP kérés	Adatok
Init	POST	method=Init 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
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 (Teya RPG) GP (Global Payments) KHB OTPSimple (SimplePay) PayPalRest PayU2 (Classic) PayURest Saferpay (Worldline) Stripe UniCredit VivaWallet	A tranzakcióhoz kiválasztott fizetési szolgáltató.
ResponseUrl	string (255 karakter)	szabadon választható	Visszatérési URL: tranzakciót követően, rendszerünk erre a címre irányítja vissza a vásárlót.
NotificationUrl	string (255 karakter)	szabadon választható	Rendszerünk ezen a címen értesíti a kereskedőt a tranzakció státuszának változásáról (URL értesítés).
Amount	number	szabadon választható	Bruttó végösszeg amit a vásárló kifizet. (Magyar forint (HUF) esetén értéke egész szám.)
AutoCommit	string	“false”	Jelzi, hogy a vásárló kétlépcsős fizetést indít és a megadott összeget a bank befoglalhatja a vásárló számláján.
Info	string	egyedi értékek	A vásárlás és a vásárló adatai az erős ügyfél-hitelesítéshez (PSD2/SCA).

Opcionális paraméterek

Paraméter	Típus	Érték	Leírás
Currency	string (3 karakter)	HUF (alapért.) EUR USD ...	A fizetés devizaneme. (Értékei fizetési szolgáltatónként és szerződésenként eltérőek lehetnek.)
OrderId	string (255 karakter)	egyedi értékek (kivéve e-mail címek, illetve személyes adatok)	A megrendelés azonosítója a kereskedő áruházában. (Lehetővé teszi a tranzakció visszakeresését, használata erősen javasolt.)
UserId	string (255 karakter)	egyedi értékek (kivéve e-mail címek, illetve személyes adatok)	A vásárló azonosítója a kereskedő áruházában. (Lehetővé teszi a tranzakció visszakeresését, használata erősen javasolt.)
Language	string (2 karakter)	HU (alapért.) EN DE ... (ISO 639-1 alapján)	A fizetési felület nyelve.
Extra	string	egyedi értékek	Kiegészítő vagy szolgáltató specifikus adatok. (extra paraméter használata)
ModuleName	string (32 karakter)	egyedi értékek	A kereskedő oldalán használt szervizcsomag, programnyelv, keretrendszer, modul, stb. megnevezése.
ModuleVersion	string (8 karakter)	verziószám	A kereskedő oldalán használt szervizcsomag, programnyelv, keretrendszer, modul, stb. verziószáma.

Mintakód

Kétlépcsős tranzakció inicializálása Init 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 'Init | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=Init' \
  --data 'json=
    {
        "StoreName":"sdk_test",
        "ProviderName":"Borgun2",
        "ResponseUrl":"https://demo.paymentgateway.hu/response.php",
        "NotificationUrl":"https://www.notification.url/bfpg",
        "Amount":100,
        "Currency":"HUF",
        "OrderId":"BF-TEST-ORDER",
        "UserId":"BF-TEST-USER",
        "AutoCommit":"false"
    }'

API válasz paraméterek

Az Init 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	Sikeres inicializálás: 32 karakter hosszú md5 hash Sikertelen inicializálás: null	A tranzakció azonosítója a BIG FISH Payment Gateway rendszerében.
ResultCode	string	Sikeres inicializálás: SUCCESSFUL Sikertelen inicializálás: InactiveStore InactiveProvider MissingParameter MissingRemoteAddress UnauthorizedAccess UnauthorizedRemoteAddress UnknownParameter UnknownProvider UnknownProviderForStore UnknownStore WrongApikey WrongParameter WrongProviderSettings Illetve további szolgáltató specifikus eredménykódok.	Jelzi a tranzakció inicializálás eredményét. Sikertelen inicializálás esetén jelzi a hiba okát. A felsoroltakon kívül további szolgáltató specifikus eredménykódokat is tartalmazhat.
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

Sikeres inicializálásra adott válasz:

{
    "TransactionId": "992c8e75435e6d4dfdf6415f0714cae8",
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": null,
    "ResponseId": "3202109280600047703"
}