Tranzakció inicializálása (Init) (fizetőeszköz-regisztrációhoz)
Last updated
Last updated
Használja az inicializálás (Init) funkciót fizetőeszköz-regisztrációjához és egy új fizetési tranzakció kezdeményezésére. Az inicializálás során a kereskedő oldala átadja a tranzakció és 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.
Az inicializálás 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.
Adja meg a kereskedő rendszerében tárolt, egyedi UserId paramétert (megadása fizetőeszköz-regisztrációnál kötelező). Az egyes vásárlók az inicializálás során átadott UserId paraméter segítségével azonosíthatók be (egy vásárló akár több fizetőeszközt is regisztrálhat).
Adja át a PaymentRegistration és a PaymentRegistrationType paramétereket a sikeres fizetőeszköz-regisztrációhoz.
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.
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 mobilalkalmazásban.
| Művelet | HTTP kérés | Adatok |
|---|---|---|
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
Tranzakció inicializálása Init kérés használatával:
Az Init kérés eredményét JSON formában válaszoljuk meg. A válasz a következő paramétereket tartalmazza:
Sikeres inicializálásra adott válasz:
| Paraméter | Típus | Érték | Leírás |
|---|---|---|---|
| Paraméter | Típus | Érték | Leírás |
|---|---|---|---|
| Paraméter | Típus | Érték | Leírás |
|---|---|---|---|
Init
POST
method=Init
json={JSON encode-olt paraméterek}
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
PayURest
Saferpay (Worldline)
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.
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.
PaymentRegistration
boolean
true
Jelzi a fizetőeszköz-regisztráció indítását.
PaymentRegistrationType
string
(3 karakter)
CIT
(a regisztrációra hivatkozó későbbi tranzakciók egykattintásos fizetéseket hoznak létre)
Meghatározza a (PSD2 szabványos) fizetőeszköz-regisztráció típusát.
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).
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.)
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.
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.