ENG

Fizetési hivatkozás létrehozása

Működés

Használja a PaymentLinkCreate funkciót egy új fizetési link létrehozásához.

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

API kérés paraméterek

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

MűveletHTTP kérésAdatok

PaymentLinkCreate

POST

method=PaymentLinkCreate 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ő és opcionálisan kötelező paraméterek

  • opcionális paraméterek

Kötelező és opcionálisan kötelező paraméterek

ParaméterTípusÉrtékLeí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

  • BBAruhitel (MBH Online Áruhitel)

  • Borgun (Teya SecurePay)

  • Borgun2 (Teya RPG)

  • CIB

  • GP (Global Payments)

  • KHB (K&H Bank)

  • KHBSZEP

  • MKBSZEP

  • OTP

  • OTPAruhitel (OTP Bank Áruhitel)

  • OTPSimple (SimplePay)

  • OTPSimpleWire

  • PayPal

  • PayPalRest

  • PayU2 (Classic)

  • PayURest

  • PSC (Paysafecard)

  • RaiffeisenPay

  • RawMBHSZEP

  • RawOTPSZEP

  • Saferpay (Worldline)

  • Stripe

  • UniCredit

  • VivaWallet

A fizetési hivatkozáshoz kiválasztott fizetési szolgáltató.

Amount

(opcionálisan kötelező)

number

szabadon választható

(Magyar forint (HUF) esetén értéke pozitív egész szám.)

Bruttó végösszeg amit a vásárló kifizet.

Ahhoz, hogy a fizetendő végösszeget a vásárló adhassa meg, figyeljen a következőkre:

• az Amount paraméter ne kerüljön átadásra,

• vagy átadása esetén az értéke legyen 0

Ilyen esetben a vásárló a MinimumAmount és MaximumAmount értékek közötti összeget írhat be.

Az Amount megadása kötelező, amennyiben a MinimumAmount értéke 0 vagy nincs beállítva!

MinimumAmount

(opcionálisan kötelező)

number

szabadon választható

(Magyar forint (HUF) esetén értéke pozitív egész szám.)

A minimum bruttó végösszeg amit a vásárló beállíthat, amennyiben a végső fizetendő összeget a vásárló állíthatja be.

A MinimumAmount megadása kötelező, amennyiben az Amount értéke 0 vagy nincs beállítva!

EmailNotificationOnlySuccess

boolean

  • true

  • false

Amennyiben értéke true, rendszerünk kizárólag a sikeres tranzakcióról küld értesítést.

(Ebben az esetben a sikertelen tranzakcióról és a fizetési hivatkozás státuszának változásairól nem küldünk értesítést.)

NotificationUrl

string

(255 karakter)

Rendszerünk ezen a címen értesíti a kereskedőt a fizetési hivatkozással létrehozott tranzakció státuszának változásáról (URL értesítés).

Opcionális paraméterek

ParaméterTípusÉrtékLeírás

NotificationEmail

string

szabványos email formátum

(maximum 1 db)

A kereskedő értesítési email címe, melyre rendszerünk a következő értesítéseket küldi:

  • tranzakció sikeres végrehajtása a fizetési hivatkozással

  • változás a fizetési hivatkozás státuszában

MaximumAmount

number

szabadon választható

(Magyar forint (HUF) esetén értéke pozitív egész szám.)

A maximum bruttó összeghatár amit a vásárló beállíthat (amennyiben a végső fizetendő összeget a vásárló állíthatja be).

Ha nem kerül átadásra, a vásárló felső összeghatár nélkül állíthat be összeget. A MaximumAmount kizárólag a MinimumAmount paraméterrel együtt használható.

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.

Language

string (2 karakter)

  • HUF (alapért.)

  • EUR

  • USD

  • ...

(ISO 639-1 alapján)

A fizetési felület nyelve.

AutoCommit

string

  • “true” (alapért.)

  • “fasle”

Jelzi, hogy a bank azonnal vagy később hajtja végre a tranzakciót.

ExpirationTime

string

dátum, a következő formátumban:

ÉÉÉÉ-HH-NN ÓÓ:PP:MM

Meghatározza a link lejárati idejét. Az érvényesség maximálisan megadható ideje is 1 év.

Amennyiben nincs megadva a lejárati idő, úgy automatikusan 1 évre kerül beállításra.

InfoForm

string

  • product

  • service

Meghatározza a fizetési hivatkozás érkező oldalán bekérésre kerülő vásárlói adatokat (ezek az erős ügyfél-hitelesítéshez (PSD2/SCA) szükségesek).

A bekért adatokról a táblázat végén olvashat további részleteket.

PrivacyPolicyUrl

string (255 karakter)

szabadon választható (URL cím)

A kereskedői adatvédelmi nyilatkozatra mutató hivatkozás. Megadása esetén a vásárlónak el kell fogadnia a nyilatkozatot a fizetés előtt (a fizetési hivatkozás kezdő oldalán).

RedirectUrl

string (255 karakter)

szabadon választható (URL cím)

A fizetést követően a vásárló egy PayLink végoldalra kerül visszairányításra. Ha a RedirectUrl meg van adva, akkor ezen a végoldalon megjelenik egy "Vissza a kereskedő oldalára" gomb, amivel a vásárló a megadott RedirectUrl címre juthat.

Extra

string

egyedi értékek

Egyéb, illetve szolgáltató specifikus adatok.

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).

ModuleName

string (32 karakter)

egyedi értékek

Az alkalmazott szervizcsomag, programnyelv, keretrendszer, modul, stb. megnevezése.

ModuleVersion

string (8 karakter)

egyedi értékek

Az alkalmazott szervizcsomag, programnyelv, keretrendszer, modul, stb. verziószáma.

InfoForm adatok részletei

Az InfoForm értékei meghatározzák, hogy a PayLink érkező oldalán milyen adatok kerülnek bekérésre, a következők szerint:

Adat típusaTermék típus (product)Szolgáltatás típus (service)

Általános vásárlói adatok

tartalmazza

tartalmazza

Számlázási adatok

tartalmazza

tartalmazza

Szállítási adatok

tartalmazza

nem tartalmazza

Mintakód

Fizetési hivatkozás létrehozása PaymentLinkCreate 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 'PaymentLinkCreate | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=PaymentLinkCreate' \
  --data 'json=
    {
        "StoreName":"sdk_test",
        "ProviderName":"Borgun2",
        "Amount":100,
        "Currency":"HUF",
        "NotificationEmail":"paymentlink@notification.email",
        "EmailNotificationOnlySuccess":false,
        "OrderId":"BF-TEST-ORDER-LINK",
        "UserId":"BF-TEST-USER-LINK"
    }'

API válasz paraméterek

A PaymentLinkCreate kérést eredményét JSON formában válaszoljuk meg. A válasz a következő paramétereket tartalmazza:

ParaméterTípusÉrtékLeírás

PaymentLinkName

string

(35 karakter)

egyedi értékek

A fizetési hivatkozás egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

PaymentLinkUrl

string

URL cím

A fizetési hivatkozás URL címe.

PaymentLinkQR

string

URL cím

A fizetési hivatkozáshoz tartozó QR-kód URL címe. Figyeljen arra, hogy a QR-kód funkció be legyen kapcsolva a PayAdminban, ellenkező esetben a visszatérési érték NULL lesz. A QR-kód funkció bekapcsolását külön kell kérelmezni ügyfélszolgálatunkon.

ResultCode

string

  • SUCCESSFUL

Hiba esetén a következő eredménykódok jelölik a hiba okát:

  • InactiveStore

  • InactiveProvider

  • MissingParameter

  • MissingRemoteAddress

  • UnauthorizedAccess

  • UnauthorizedRemoteAddress

  • UnknownProvider

  • UnknownProviderForStore

  • UnknownStore

  • UnknownTransaction

  • WrongApikey

  • WrongParameter

  • WrongProviderSettings

A fizetési hivatkozás létrehozásának eredménye.

ResultMessage

string

leírás

Az egyes ResultCode értékek szöveges magyarázata.

Amount

number

az API kérésben megadott érték

Bruttó végösszeg amit a vásárló kifizet.

Currency

string

(3 karakter)

az API kérésben megadott érték

A fizetés devizaneme.

MultipleTransactions

boolean

  • false

Jelzi, hogy a fizetési link csak egyszer felhasználható fel sikeres fizetésre.

Language

string

(2 karakter)

  • HU (alapért.)

  • EN

  • DE

  • …

(Az API kérésben megadott érték.)

A fizetési felület nyelve.

OrderId

string

egyedi értékek (kivéve e-mail címek, illetve személyes adatok)

(Az API kérésben megadott érték.)

A megrendelés azonosítója a kereskedő áruházában.

UserId

string

egyedi értékek (kivéve e-mail címek, illetve személyes adatok)

(Az API kérésben megadott érték.)

A vásárló azonosítója a kereskedő áruházában.

AutoCommit

string

  • “true”

  • “fasle”

(Az API kérésben megadott érték.)

Jelzi, hogy a bank azonnal vagy később hajtja végre a tranzakciót.

ExpirationTime

string

dátum, a következő formátumban:

ÉÉÉÉ-HH-NN ÓÓ:PP:MM

(Az API kérésben megadott érték.)

Meghatározza a link lejárati idejét.

NotificationUrl

string

(255 karakter)

szabadon választható

(Az API kérésben megadott érték.)

Rendszerünk ezen a címen értesíti a kereskedőt a fizetési hivatkozással létrehozott tranzakció státuszának változásáról (URL értesítés).

NotificationEmail

string

szabványos email formátum

(Az API kérésben megadott érték.)

A kereskedő értesítési email címe, melyre rendszerünk a következő értesítéseket küldi:

  • tranzakció sikeres végrehajtása a fizetési hivatkozással

  • változás a fizetési hivatkozás státuszában

EmailNotificationOnlySuccess

boolean

  • true

  • false

(Az API kérésben megadott érték.)

Amennyiben értéke true, rendszerünk kizárólag a sikeres tranzakcióról küld értesítést. (Ebben az esetben a sikertelen tranzakcióról és a fizetési hivatkozás státuszának változásairól nem küldünk értesítést.)

Extra

string

egyedi értékek

(Az API kérésben megadott érték.)

Egyéb illetve szolgáltató specifikus adatok.

Status

string

  • PENDING

  • SUCCESSFUL

  • ERROR

  • CANCELED

  • TIMEOUT

A fizetési hivatkozás státusza.

Created

string

dátum, a következő formátumban:

ÉÉÉÉ-HH-NN ÓÓ:PP:MM

A fizetési hivatkozás létrehozásának ideje.

LastModified

string

dátum, a következő formátumban:

ÉÉÉÉ-HH-NN ÓÓ:PP:MM

A fizetési hivatkozás utolsó módosításának ideje.

ResponseId

integer

egyedi értékek

A válaszüzenet egyedi azonosítója a BIG FISH Payment Gateway rendszerében.

Mintakód

Fizetési hivatkozás sikeres létrehozására adott válasz:

{
    "PaymentLinkName": "pl_d6b8323abb1c839a8cd6434c67bbbbef",
    "PaymentLinkUrl": "https://system-test.paymentgateway.hu/PaymentLink/pl_d6b8323abb1c839a8cd6434c67bbbbef",
    "PaymentLinkQR": "https://system-test.paymentgateway.hu/PaymentQR/pl_d6b8323abb1c839a8cd6434c67bbbbef.png",
    "ResultCode": "SUCCESSFUL",
    "ResultMessage": "Fizetési link létrehozása sikeres",
    "ProviderName": "Borgun2",
    "Amount": 100,
    "Currency": "HUF",
    "MultipleTransactions": false,
    "Language": "HU",
    "OrderId": "BF-TEST-ORDER",
    "UserId": "BF-TEST-USER",
    "AutoCommit": true,
    "ExpirationTime": "2018-11-20 14:43:31",
    "NotificationUrl": null,
    "NotificationEmail": "paymentlink@notification.email",
    "EmailNotificationOnlySuccess": false,
    "EmailNotificationTime": null,
    "Extra": null,
    "Status": "PENDING",
    "Created": "2017-11-20 14:43:31",
    "LastModified": "2017-11-20 14:43:31",
    "ResponseId": "3202109280600047725"
}
PreviousFizetési hivatkozás (PayLink)NextFizetési hivatkozás részletes adatainak lekérdezése

Last updated