> For the complete documentation index, see [llms.txt](https://docs.nevogate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nevogate.com/kiegeszito-szolgaltatasok/fizetesi-hivatkozas-paylink/fizetesi-hivatkozas-letrehozasa.md).

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

[<mark style="color:blue;background-color:blue;">**Próbálja ki ezt a funkciót**</mark>](https://demo.nevogate.com/views/?action=paymentLinkCreate)<mark style="color:blue;background-color:blue;">**!**</mark>

### API kérés paraméterek

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

<table data-full-width="true"><thead><tr><th>Művelet</th><th>HTTP kérés</th><th>Adatok</th></tr></thead><tbody><tr><td><code>PaymentLinkCreate</code></td><td><code>POST</code></td><td>method=<code>PaymentLinkCreate</code><br><br>json={JSON encode-olt paraméterek}</td></tr></tbody></table>

{% hint style="info" %}
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.
{% endhint %}

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**

<table data-full-width="true"><thead><tr><th width="325">Paraméter</th><th width="141">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>StoreName</code></td><td>string</td><td>A <em>Nevogate</em> szerződésben kerül meghatározásra.</td><td>Rendszerünkben tárolt egyedi bolt azonosító.</td></tr><tr><td><code>ProviderName</code></td><td>string</td><td><ul><li>Barion2</li><li>BBAruhitel (<em>MBH</em> <em>Online Áruhitel</em>)</li><li>Borgun (<em>Teya SecurePay</em>)</li><li>Borgun2 (<em>Teya RPG</em>)</li><li>CIB</li><li>GoPay</li><li>GP (<em>Global Payments</em>)</li><li>Granit (Gránit FairPay)</li><li>KHB (<em>K&#x26;H Bank</em>)</li><li>KHBSZEP</li><li>MKBSZEP</li><li>OTP</li><li>OTPAruhitel (<em>OTP Bank Áruhitel</em>)</li><li>OTPSimple (<em>SimplePay</em>)</li><li>OTPSimpleRtp (<em>SimplePay</em>)</li><li>OTPSimpleWire</li><li>PayPal</li><li>PayPalRest</li><li>PayU2 (<em>Classic</em>)</li><li>PayURest</li><li>PSC (<em>Paysafecard</em>)</li><li>RaiffeisenPay</li><li>RaiffeisenUPC</li><li>RawMBHSZEP</li><li>RawOTPSZEP</li><li>Saferpay (<em>Worldline</em>)</li><li>Stripe</li><li>VivaWallet</li></ul></td><td>A fizetési hivatkozáshoz kiválasztott fizetési szolgáltató.</td></tr><tr><td><p><code>Amount</code><br></p><p>(opcionálisan kötelező)</p></td><td>number</td><td><p>szabadon választható<br></p><p>(Magyar forint (HUF) esetén értéke pozitív egész szám.)</p></td><td><p>Bruttó végösszeg amit a vásárló kifizet.<br></p><p>Ahhoz, hogy a fizetendő végösszeget a vásárló adhassa meg, figyeljen a következőkre:</p><p>• az <code>Amount</code> paraméter ne kerüljön átadásra,</p><p>• vagy átadása esetén az értéke legyen 0</p><p>Ilyen esetben a vásárló a <code>MinimumAmount</code> és <code>MaximumAmount</code> értékek közötti összeget írhat be.</p><p>Az <code>Amount</code> <strong>megadása kötelező, amennyiben</strong> a <code>MinimumAmount</code> értéke 0 vagy nincs beállítva!</p></td></tr><tr><td><p><code>MinimumAmount</code></p><p>(opcionálisan kötelező)</p></td><td>number</td><td><p>szabadon választható<br></p><p>(Magyar forint (HUF) esetén értéke pozitív egész szám.)</p></td><td><p>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.</p><p>A <code>MinimumAmount</code> <strong>megadása kötelező, amennyiben</strong> az <code>Amount</code> értéke 0 vagy nincs beállítva!</p></td></tr><tr><td><code>EmailNotificationOnlySuccess</code></td><td>boolean</td><td><ul><li>true</li><li>false</li></ul></td><td><p>Amennyiben értéke <code>true</code>, rendszerünk kizárólag a sikeres tranzakcióról küld értesítést.</p><p>(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.)</p></td></tr><tr><td><code>NotificationUrl</code></td><td><p>string</p><p>(255 karakter)</p></td><td></td><td>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 (<a href="/pages/AyUvdciGvvztBBDbuovo">URL értesítés</a>).</td></tr></tbody></table>

#### **Opcionális paraméterek**

<table data-full-width="true"><thead><tr><th width="326">Paraméter</th><th width="141">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>NotificationEmail</code></td><td>string</td><td><p>szabványos email formátum<br></p><p>(maximum 1 db)</p></td><td><p>A kereskedő értesítési email címe, melyre rendszerünk a következő értesítéseket küldi:</p><ul><li>tranzakció sikeres végrehajtása a fizetési hivatkozással</li><li>változás a fizetési hivatkozás státuszában</li></ul></td></tr><tr><td><code>MaximumAmount</code></td><td>number</td><td><p>szabadon választható<br></p><p>(Magyar forint (HUF) esetén értéke pozitív egész szám.)</p></td><td><p>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).<br></p><p>Ha nem kerül átadásra, a vásárló felső összeghatár nélkül állíthat be összeget.<br><br>A <code>MaximumAmount</code> <strong>kizárólag a</strong> <code>MinimumAmount</code> <strong>paraméterrel együtt</strong> használható.</p></td></tr><tr><td><code>Currency</code></td><td><p>string<br></p><p>(3 karakter)</p></td><td><ul><li>HUF (alapért.)</li><li>EUR</li><li>USD</li><li>...</li></ul></td><td><p>A fizetés devizaneme.<br></p><p>(Értékei fizetési szolgáltatónként és szerződésenként eltérőek lehetnek.)</p></td></tr><tr><td><code>OrderId</code></td><td>string<br><br>(255 karakter)</td><td>egyedi értékek<br><br>(kivéve e-mail címek, illetve személyes adatok)</td><td><p>A megrendelés azonosítója a kereskedő áruházában.<br></p><p>(Lehetővé teszi a tranzakció visszakeresését, használata erősen javasolt.)</p></td></tr><tr><td><code>UserId</code></td><td>string<br><br>(255 karakter)</td><td>egyedi értékek<br><br>(kivéve e-mail címek, illetve személyes adatok)</td><td>A vásárló azonosítója a kereskedő áruházában.</td></tr><tr><td><code>Language</code></td><td>string<br><br>(2 karakter)</td><td><ul><li>HUF (alapért.)</li><li>EUR</li><li>USD</li><li>...</li></ul><p>(ISO 639-1 alapján)</p></td><td>A fizetési felület nyelve.</td></tr><tr><td><code>AutoCommit</code></td><td>string</td><td><ul><li>“true” (alapért.)</li><li>“fasle”</li></ul></td><td>Jelzi, hogy a bank azonnal vagy később hajtja végre a tranzakciót.</td></tr><tr><td><code>ExpirationTime</code></td><td>string</td><td><p>dátum, a következő formátumban:<br></p><p>ÉÉÉÉ-HH-NN ÓÓ:PP:MM</p></td><td><p>Meghatározza a link lejárati idejét.<br><br>Az érvényesség maximálisan megadható ideje is 1 év.<br></p><p>Amennyiben nincs megadva a lejárati idő, úgy automatikusan 1 évre kerül beállításra.<br><br></p></td></tr><tr><td><code>InfoForm</code></td><td>string</td><td><ul><li>product</li><li>service</li></ul></td><td><p>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).<br></p><p>A bekért adatokról a táblázat végén olvashat további részleteket.</p></td></tr><tr><td><code>PrivacyPolicyUrl</code></td><td>string<br><br>(255 karakter)</td><td>szabadon választható<br><br>(URL cím)</td><td>A kereskedői adatvédelmi nyilatkozatra mutató hivatkozás.<br><br>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).</td></tr><tr><td><code>RedirectUrl</code></td><td>string<br><br>(255 karakter)</td><td>szabadon választható<br><br>(URL cím)</td><td>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.</td></tr><tr><td><code>Extra</code></td><td>string</td><td>egyedi értékek</td><td>Egyéb, illetve szolgáltató specifikus adatok.</td></tr><tr><td><code>Info</code></td><td>string</td><td>egyedi értékek</td><td>A vásárlás és a vásárló adatai az erős ügyfél-hitelesítéshez (<a href="/pages/w2bB87azm3s2wK3Gnlgp">PSD2/SCA</a>).</td></tr><tr><td><code>ModuleName</code></td><td>string<br><br>(32 karakter)</td><td>egyedi értékek</td><td>Az alkalmazott szervizcsomag, programnyelv, keretrendszer, modul, stb. megnevezése.</td></tr><tr><td><code>ModuleVersion</code></td><td>string<br><br>(8 karakter)</td><td>egyedi értékek</td><td>Az alkalmazott szervizcsomag, programnyelv, keretrendszer, modul, stb. verziószáma.</td></tr></tbody></table>

#### 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:

<table data-full-width="true"><thead><tr><th>Adat típusa</th><th>Termék típus (product)</th><th>Szolgáltatás típus (service)</th></tr></thead><tbody><tr><td>Általános vásárlói adatok</td><td>tartalmazza</td><td>tartalmazza</td></tr><tr><td>Számlázási adatok</td><td>tartalmazza</td><td>tartalmazza</td></tr><tr><td>Szállítási adatok</td><td>tartalmazza</td><td>nem tartalmazza</td></tr></tbody></table>

#### **Mintakód**

Fizetési hivatkozás létrehozása `PaymentLinkCreate` kérés használatával:

{% code overflow="wrap" %}

```php
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":"TEST-ORDER-ID-LINK",
        "UserId":"TEST-USER-ID-LINK"
    }'
```

{% endcode %}

### 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:

<table data-full-width="true"><thead><tr><th width="326">Paraméter</th><th width="141">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>PaymentLinkName</code></td><td><p>string<br></p><p>(35 karakter)</p></td><td>egyedi értékek</td><td>A fizetési hivatkozás egyedi azonosítója a <em>Nevogate</em> rendszerében.</td></tr><tr><td><code>PaymentLinkUrl</code></td><td>string</td><td>URL cím</td><td>A fizetési hivatkozás URL címe.</td></tr><tr><td><code>PaymentLinkQR</code></td><td>string</td><td>URL cím</td><td>A fizetési hivatkozáshoz tartozó QR-kód URL címe.<br><br>Figyeljen arra, hogy a QR-kód funkció be legyen kapcsolva a PayAdminban, ellenkező esetben a visszatérési érték <code>NULL</code> lesz.<br>A QR-kód funkció bekapcsolását külön kell kérelmezni ügyfélszolgálatunkon.</td></tr><tr><td><code>ResultCode</code></td><td>string</td><td><ul><li>SUCCESSFUL</li></ul><p>Hiba esetén a következő eredménykódok jelölik a hiba okát:</p><ul><li>InactiveStore</li><li>InactiveProvider</li><li>MissingParameter</li><li>MissingRemoteAddress</li><li>UnauthorizedAccess</li><li>UnauthorizedRemoteAddress</li><li>UnknownProvider</li><li>UnknownProviderForStore</li><li>UnknownStore</li><li>UnknownTransaction</li><li>WrongApikey</li><li>WrongParameter</li><li>WrongProviderSettings</li></ul></td><td>A fizetési hivatkozás létrehozásának eredménye.</td></tr><tr><td><code>ResultMessage</code></td><td>string</td><td>leírás</td><td>Az egyes <code>ResultCode</code> értékek szöveges magyarázata.</td></tr><tr><td><code>Amount</code></td><td>number</td><td>az API kérésben megadott érték</td><td>Bruttó végösszeg amit a vásárló kifizet.</td></tr><tr><td><code>Currency</code></td><td><p>string<br></p><p>(3 karakter)</p></td><td>az API kérésben megadott érték</td><td>A fizetés devizaneme.</td></tr><tr><td><code>MultipleTransactions</code></td><td>boolean</td><td><ul><li>false</li></ul></td><td>Jelzi, hogy a fizetési link csak egyszer felhasználható fel sikeres fizetésre.</td></tr><tr><td><code>Language</code></td><td><p>string<br></p><p>(2 karakter)</p></td><td><ul><li>HU (alapért.)</li><li>EN</li><li>DE</li><li>…</li></ul><p>(Az API kérésben megadott érték.)</p></td><td>A fizetési felület nyelve.</td></tr><tr><td><code>OrderId</code></td><td>string</td><td><p>egyedi értékek<br><br>(kivéve e-mail címek, illetve személyes adatok)<br></p><p>(Az API kérésben megadott érték.)</p></td><td>A megrendelés azonosítója a kereskedő áruházában.</td></tr><tr><td><code>UserId</code></td><td>string</td><td><p>egyedi értékek<br><br>(kivéve e-mail címek, illetve személyes adatok)<br></p><p>(Az API kérésben megadott érték.)</p></td><td>A vásárló azonosítója a kereskedő áruházában.</td></tr><tr><td><code>AutoCommit</code></td><td>string</td><td><ul><li>“true”</li><li>“fasle”<br></li></ul><p>(Az API kérésben megadott érték.)</p></td><td>Jelzi, hogy a bank azonnal vagy később hajtja végre a tranzakciót.</td></tr><tr><td><code>ExpirationTime</code></td><td>string</td><td><p>dátum, a következő formátumban:<br></p><p>ÉÉÉÉ-HH-NN ÓÓ:PP:MM<br></p><p>(Az API kérésben megadott érték.)</p></td><td>Meghatározza a link lejárati idejét.</td></tr><tr><td><code>NotificationUrl</code></td><td><p>string<br></p><p>(255 karakter)</p></td><td><p>szabadon választható<br></p><p>(Az API kérésben megadott érték.)</p></td><td>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 (<a href="/pages/AyUvdciGvvztBBDbuovo">URL értesítés</a>).</td></tr><tr><td><code>NotificationEmail</code></td><td>string</td><td><p>szabványos email formátum<br></p><p>(Az API kérésben megadott érték.)</p></td><td><p>A kereskedő értesítési email címe, melyre rendszerünk a következő értesítéseket küldi:</p><ul><li>tranzakció sikeres végrehajtása a fizetési hivatkozással</li><li>változás a fizetési hivatkozás státuszában</li></ul></td></tr><tr><td><code>EmailNotificationOnlySuccess</code></td><td>boolean</td><td><ul><li>true</li><li>false</li></ul><p>(Az API kérésben megadott érték.)</p></td><td>Amennyiben értéke <code>true</code>, rendszerünk kizárólag a sikeres tranzakcióról küld értesítést.<br><br>(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.)</td></tr><tr><td><code>Extra</code></td><td>string</td><td><p>egyedi értékek<br></p><p>(Az API kérésben megadott érték.)</p></td><td>Egyéb illetve szolgáltató specifikus adatok.</td></tr><tr><td><code>Status</code></td><td>string</td><td><ul><li>PENDING</li><li>SUCCESSFUL</li><li>ERROR</li><li>CANCELED</li><li>TIMEOUT</li></ul></td><td>A fizetési hivatkozás státusza.</td></tr><tr><td><code>Created</code></td><td>string</td><td><p>dátum, a következő formátumban:<br></p><p>ÉÉÉÉ-HH-NN ÓÓ:PP:MM</p></td><td>A fizetési hivatkozás létrehozásának ideje.</td></tr><tr><td><code>LastModified</code></td><td>string</td><td><p>dátum, a következő formátumban:<br></p><p>ÉÉÉÉ-HH-NN ÓÓ:PP:MM</p></td><td>A fizetési hivatkozás utolsó módosításának ideje.</td></tr><tr><td><code>ResponseId</code></td><td>integer</td><td>egyedi értékek</td><td>A válaszüzenet egyedi azonosítója a <em>Nevogate</em> rendszerében.</td></tr></tbody></table>

#### **Mintakód**

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

{% code overflow="wrap" %}

```php
{
    "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": "TEST-ORDER-ID",
    "UserId": "TEST-USER-ID",
    "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"
}
```

{% endcode %}