# Visszatérítési igény lekérdezése (SettlementRefund)

Használja a `SettlementRefund` kérést a korábban leadott *SZÉP Kártya* visszatérítések adatainak lekérdezésére (abban az esetben, ha a *SZÉP Kártya* visszatérítéseket a *SZÉP Refund* kiegészítő szolgáltatás segítségével indította). A *SZÉP Kártyás* visszatérítési kérésekről a beküldés másnapján egy csv állományt generálunk, mely tartalmazza a visszatérítés végrehajtásához szükséges információkat a fizetési szolgáltatók számára. Ezeket az állományokat naponta továbbítjuk a fizetési szolgáltatók felé email vagy SFTP segítségével. Igény esetén ezeket a csv állományokat a kereskedő számára is továbbítjuk e-mailben (befogadási e-mail cím megadását követően).

Elkészítettünk egy minta csv kimutatást is, melyet a következő hivatkozáson tölthet le:

[*SZÉP Refund* csv minta](https://www.nevogate.com/static/downloads/refund_111111_20201126_72ab2a61.csv)

{% hint style="info" %}
A kiegészítő szolgáltatásokat, így a *SZÉP Refund* használatát is külön kell kérelmezni ügyfélszolgálatunkon, melyet a következő címre írt üzenettel tehet meg:

<business@nevogate.com>\
\
A fizetési szolgáltatók által ténylegesen teljesített visszatérítési tranzakciók eredményét és a pénzügyi elszámolási adatokat a *PayBook* kiegészítő szolgáltatásunk segítségével kérdezheti le a *PayAdmin* felületén manuálisan, vagy API kérés segítségével automatizálva.

További részletekért a funkció használatáról látogassa meg a következő oldalt:

[Könyvelés támogatás és tranzakciók pénzügyi elszámolása (*PayBook*)](https://docs.nevogate.com/kiegeszito-szolgaltatasok/koenyveles-tamogatas-es-tranzakciok-penzuegyi-elszamolasa-paybook)
{% endhint %}

### Működés

Használja a `SettlementRefund` funkciót a korábban leadott *SZÉP Kártya* visszatérítési igények lekérdezéséhez. A lekérdezés a következő adatokat adhatja vissza:

* visszatérítési **elszámolásnaphoz** tartozó tranzakciók
* visszatérítési **azonosítóhoz** tartozó tranzakciók

### 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>SettlementRefund</code></td><td><code>POST</code></td><td><p>method=<code>SettlementRefund</code></p><p>json={JSON encode-olt paraméterek}</p></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="120">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>Meghatározza a lekérdezett visszatérítéshez tartozó fizetési szolgáltatót.</td></tr><tr><td><code>ProviderName</code></td><td>string</td><td><ul><li>KHBSZEP</li><li>MKBSZEP</li><li>OTP</li><li>RawMBHSZEP</li><li>RawOTPSZEP</li></ul></td><td>A visszatérítési elszámolás lekérdezéséhez kiválasztott fizetési szolgáltató.</td></tr><tr><td><code>TerminalId</code></td><td>string</td><td>egyedi értékek</td><td>A kereskedő virtuális termináljának (VPOS) egyedi azonosítója.</td></tr><tr><td><code>Limit</code></td><td>number</td><td>maximum 1000 tétel</td><td><p>Az adott lekérdezés során visszaadott tételek maximális száma.</p><p>(Opcionálisan használja az <code>Offset</code> paramétert további tételek lekérdezéséhez, amennyiben az aktuális lekérdezéshez több tétel tartozik, mint a <code>Limit</code> paraméterben megadott érték.)</p></td></tr></tbody></table>

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

<table data-full-width="true"><thead><tr><th>Paraméter</th><th width="122">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>RefundSettlementDate</code></td><td>string</td><td><p>dátum, a következő formátumban:<br></p><p>ÉÉÉÉ-HH-NN</p></td><td><p>A visszatérítési elszámolás létrehozásának ideje.</p><p>Megadása <strong>kötelező, amennyiben</strong> a <code>RefundSettlementId</code> paraméter nem kerül átadásra.</p></td></tr><tr><td><code>RefundSettlementId</code></td><td>string</td><td>egyedi értékek</td><td><p>A visszatérítési elszámolás kérésének azonosítója.</p><p>Megadása <strong>kötelező, amennyiben</strong> a <code>RefundSettlementDate</code> paraméter nem kerül átadásra.</p></td></tr><tr><td><code>GetBatches</code></td><td>boolean</td><td><ul><li>true (alapért.)</li><li>false</li></ul></td><td>Meghatározza, hogy a lekérdezett válasz tartalmazzon vagy ne tartalmazzon köteg adatokat.</td></tr><tr><td><code>GetItems</code></td><td>boolean</td><td><ul><li>true (alapért.)</li><li>false</li></ul></td><td>Meghatározza, hogy a lekérdezett válasz tartalmazzon vagy ne tartalmazzon tétel adatokat.</td></tr><tr><td><code>Offset</code></td><td>number</td><td>egyedi értékek</td><td><p>Jelzi a lekérdezett tételek számához tartozó eltolást.</p><p>Abban az esetben, amikor egy kötegben a tételek száma (<code>NumberOfItems</code>) meghaladja a lekérdezésben beállított limitet (<code>Limit</code>), használja az eltolást a limitet meghaladó további tételek lekérdezéséhez.</p></td></tr></tbody></table>

#### **Mintakód**

Visszatérítési elszámolás lekérdezése `SettlementRefund` 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 'SettlementRefund | merchant-store.com | PHP | 7.3.0' \
  --request 'POST' \
  --data 'method=SettlementRefund' \
  --data 'json=
    {
        "StoreName":"sdk_test",
        "ProviderName":"MKBSZEP",
        "TerminalId":"111111",
        "RefundSettlementDate":"2020-11-26",
        "Limit":1000
    }'
```

{% endcode %}

### API válasz paraméterek

A `SettlementRefund` 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="257">Paraméter</th><th width="124">Típus</th><th>Érték</th><th>Leírás</th></tr></thead><tbody><tr><td><code>Data</code></td><td>JSON string</td><td>egyedi értékek</td><td>Sikeres lekérdezés esetén tartalmazza a <a href="../../egyszeri-fizetesek-one-time-payment/szep-kartya/tranzakcio-oesszegenek-visszateritese-payrefund/visszateritesi-igeny-lekerdezese-settlementrefund/koeteg-batches-es-tetel-items-adatok-visszateriteseknel">köteg (Batches) és tétel (Items) adatok</a>at.</td></tr><tr><td><code>ResultCode</code></td><td>string</td><td><ul><li>SUCCESSFUL (a pénzügyi visszatérítési elszámolás lekérdezése sikeres volt)</li></ul><p><br>Hiba esetén a következő eredménykódok jelölik a hiba okát:</p><ul><li>FunctionNotImplemented</li><li>InactiveStore</li><li>MissingParameter</li><li>MissingRemoteAddress</li><li>UnauthorizedAccess</li><li>UnauthorizedRemoteAddress</li><li>UnknownProvider</li><li>UnknownProviderForStore</li><li>UnknownStore</li><li>WrongApikey</li><li>WrongParameter</li></ul></td><td>Jelzi a visszatérítési elszámolás lekérdezésének eredményét.</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>

#### **Mintakód**

A fenti `SettlementRefund` kérésre adott válasz:

{% code overflow="wrap" %}

```php
{
    "Data":"
    {
        \"Batches\":[
            {
                \"RefundSettlementId\":\"72ab2a61\",
                \"RefundSettlementDate\":\"2020-11-26\",
                \"RefundSettlementFileName\":\"refund_111111_20201126_72ab2a61.csv\",
                \"TransferNotice\":\"refund 2020-11-26 111111 72ab2a61\",
                \"ProviderName\":\"MKBSZEP\",
                \"ProviderAccountNumber\":\"10300002-13000203-00894901\",
                \"TerminalId\":\"111111\",
                \"NumberOfItems\":2,
                \"TotalRefundRequestAmount\":5500
            }
        ],
        \"Items\":[
            {
                \"RefundSettlementId\":\"72ab2a61\",
                \"OriginalTransactionId\":\"41a441422609b5bcd66bd0971386e76f\",
                \"OriginalProviderTransactionId\":\"49239229\",
                \"OriginalTransactionAnum\":\"566129\",
                \"OriginalTransactionAmount\":\"3000\",
                \"OriginalTransactionCreatedTime\":\"2020-11-26 10:34:59\",
                \"RefundRequestId\":\"49239229\",
                \"RefundTransactionId\":\"26a738c456df39af5d0685ec3844bfdc\",
                \"RefundRequestAmount\":\"3000\",
                \"RefundRequestTime\":\"2020-11-26 10:36:07\"
            },
            {
                \"RefundSettlementId\":\"72ab2a61\",
                \"OriginalTransactionId\":\"f88796bb3aebba12d816f878fc08f0aa\",
                \"OriginalProviderTransactionId\":\"49239230\",
                \"OriginalTransactionAnum\":\"559655\",
                \"OriginalTransactionAmount\":\"5000\",
                \"OriginalTransactionCreatedTime\":\"2020-11-26 10:35:36\",
                \"RefundRequestId\":\"49239230\",
                \"RefundTransactionId\":\"61e34cb499d96450718b14a083140d40\",
                \"RefundRequestAmount\":\"2500\",
                \"RefundRequestTime\":\"2020-11-26 10:36:23\"
            }
        ]
    }",
    "ResultCode": "SUCCESSFUL",
    "RefundId": "rf_b0fd9b0381bb54568870a6c22d6a086f",
    "ResultMessage": null,
    "ResponseId": "3202109280600047731"
}
```

{% endcode %}