# Fizetőeszköz-regisztráció lekérdezése

### Működés

Használja a `GetPaymentRegistrations` funkciót egy adott vásárlóhoz tartozó összes regisztrált fizetőeszköz lekérdezéséhez. Sikeres lekérdezés esetén a válasz a következő adatokat tartalmazza:

* a fizetőeszköz-regisztráció típusa
* a vásárláshoz tartozó regisztrált fizetőeszköz(ök) adatai
* a fizetőeszköz-regisztráció(k) során létrejött referencia tranzakció(k) adatai

{% hint style="warning" %}
Az érvénytelenített fizetőeszköz-regisztrációk és a lejárt fizetőeszközök adatait nem adjuk vissza.
{% endhint %}

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

### **Az API kérés paraméterei**

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

<table data-full-width="true"><thead><tr><th>Művelet</th><th width="136">HTTP kérés</th><th>Adatok</th></tr></thead><tbody><tr><td><code>GetPaymentRegistrations</code></td><td><code>POST</code></td><td>method=<code>GetPaymentRegistrations</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.

Az API paraméterek felosztása a következő:

* kötelező paraméterek
* opcionális paraméterek
  {% endhint %}

#### Kötelező paraméterek

<table data-full-width="true"><thead><tr><th>Paraméter</th><th width="105">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>Borgun2 (Teya RPG)</li><li>CIB</li><li>GP (<em>Global Payments</em>)</li><li>KHB</li><li>OTPSimple (<em>SimplePay</em>)</li><li>PayPalRest</li><li>PayURest</li><li>RaiffeisenUPC</li><li>Saferpay (Worldline)</li><li>VivaWallet</li></ul></td><td>A tranzakcióhoz tartozó fizetési szolgáltató.</td></tr><tr><td><code>UserId</code></td><td>string</td><td>szabadon választott<br><br>(kivéve e-mail címek és személyes adatok)</td><td>A fizetőeszköz-regisztrációhoz használt vásárló-azonosító a kereskedő áruházában.</td></tr></tbody></table>

#### Opcionális paraméter

<table data-full-width="true"><thead><tr><th>Paraméter</th><th width="105">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>PaymentRegistrationType</code></td><td>string</td><td><ul><li>MIT</li></ul></td><td>A fizetőeszköz-regisztráció típusa.</td></tr></tbody></table>

#### **Mintakód**

Adott vásárlóhoz tartozó fizetőeszköz-regisztrációk lekérdezése `GetPaymentRegistrations` 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 'GetPaymentRegistrations | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=GetPaymentRegistrations' \
  --data 'json=
    {
        "StoreName":"sdk_test",
        "ProviderName":"Barion2",
        "UserId":"TEST-USER-ID-REG"
    }'
```

{% endcode %}

### API válasz paraméterek

A `GetPaymentRegistrations` kérés 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="227">Paraméter</th><th width="129">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><a href="#a-data-parameter-elemei"><code>Data</code></a></td><td>JSON object</td><td>egyedi értékek</td><td>Fizetőeszköz-regisztrációkat és a hozzájuk tartozó referencia tranzakciókat tartalmazó objektum.</td></tr><tr><td><code>ResultCode</code></td><td>string</td><td><p>A regisztráció sikeresen lekérdezve:</p><ul><li>SUCCESSFUL</li></ul><p>Sikertelen lekérdezés esetén:</p><ul><li>InactiveStore</li><li>MissingParameter</li><li>MissingRemoteAddress</li><li>UnauthorizedAccess</li><li>UnauthorizedRemoteAddress</li><li>UnknownProvider</li><li>UnknownReferenceTransaction</li><li>UnknownStore</li><li>WrongApikey</li><li>WrongParameter</li></ul></td><td><p>Jelzi a lekérdezés eredményét.</p><p>Sikertelen lekérdezés esetén a paraméter értéke jelzi a hiba okát.</p></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>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>

#### A Data paraméter elemei

Az alábbi adatok a `Data` nevű paraméterben, fizetőeszköz-regisztráció típusonként bontva kerülnek átadásra:

<table data-full-width="true"><thead><tr><th width="355">Paraméter</th><th>Leírás</th></tr></thead><tbody><tr><td><code>ReferenceTransactionId</code></td><td>A fizetőeszköz-regisztrációhoz kapcsolódó tranzakció azonosítója a <em>Nevogate</em> rendszerében.</td></tr><tr><td><code>AutoCommit</code></td><td>A referencia tranzakció végrehajtási módja, mely jelenthet azonnali terhelést vagy az összeg előzetes befoglalását.</td></tr><tr><td><code>Currency</code></td><td>A referencia tranzakció devizaneme.</td></tr><tr><td><code>PaymentDevice</code></td><td><p>A regisztrált fizetőeszköz típusa:</p><ul><li><code>BankCard</code></li><li><code>Wallet</code></li><li><code>AccountNumber</code></li></ul></td></tr><tr><td><code>PaymentDeviceBrand</code></td><td>A regisztrált fizetőeszköz márkája.</td></tr><tr><td><code>PaymentDeviceNumber</code></td><td>A regisztrált fizetőeszköz azonosító száma, pl. a bankkártya utolsó 4 számjegye, számlaszám, stb.</td></tr><tr><td><code>PaymentDeviceExpiration</code></td><td>A regisztrált fizetőeszköz lejárati ideje.</td></tr><tr><td><code>RegistrationExpiration</code></td><td>A fizetőeszköz-regisztráció érvényességének vége.</td></tr><tr><td><code>RecurringFrequency</code></td><td>A rákövetkező fizetések gyakorisága.</td></tr><tr><td><code>FixAmount</code></td><td>Jelzi, hogy a rákövetkező fizetések megegyeznek vagy nem egyeznek meg a referencia tranzakció összegével.</td></tr><tr><td><code>Created</code></td><td>A referencia tranzakció létrehozásának időpontja.</td></tr></tbody></table>

#### Mintakód

A sikeres fizetőeszköz-regisztráció lekérdezésre adott válasz:

{% code overflow="wrap" %}

```php
{
  "Data": {
    "MIT": [
      {
        "ReferenceTransactionId": "e44dcb0cefeaab4b3211c9ea5e2e6222",
        "AutoCommit": 1,
        "Currency": "HUF",
        "PaymentDevice": "BankCard",
        "PaymentDeviceBrand": "Visa",
        "PaymentDeviceNumber": "5559",
        "PaymentDeviceExpiration": "2022-01-31",
        "RegistrationExpiration": "2021-12-12",
        "RecurringFrequency": 2,
        "FixAmount": 1,
        "Created": "2021-05-26 13:48:11"
      }
    ]
  },
  "ResultCode": "SUCCESSFUL",
  "ResultMessage": null
  "ResponseId": "3202109280600047720"
}
```

{% endcode %}