Search
K
Links

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 PayRefund 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:
A kiegészítő szolgáltatásokat, így a PayRefund használatát is külön kell kérelmezni ügyfélszolgálatunkon, melyet a következő címre írt üzenettel tehet meg:
[email protected] 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:

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

Művelet
HTTP kérés
Adatok
SettlementRefund
POST
method=SettlementRefund
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ő paraméterek
  • opcionális paraméterek

Kötelező paraméterek

Paraméter
Típus
Érték
Leírás
StoreName
string
A BIG FISH Payment Gateway szerződésben kerül meghatározásra.
Meghatározza a lekérdezett visszatérítéshez tartozó fizetési szolgáltatót.
ProviderName
string
  • KHBSZEP
  • MKBSZEP
  • OTP
A visszatérítési elszámolás lekérdezéséhez kiválasztott fizetési szolgáltató.
TerminalId
string
egyedi értékek
A kereskedő virtuális termináljának (VPOS) egyedi azonosítója.
Limit
number
maximum 1000 tétel
Az adott lekérdezés során visszaadott tételek maximális száma.
(Opcionálisan használja az Offset paramétert további tételek lekérdezéséhez, amennyiben az aktuális lekérdezéshez több tétel tartozik, mint a Limit paraméterben megadott érték.)

Opcionális paraméterek

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

Mintakód

Visszatérítési elszámolás lekérdezése SettlementRefund használatával:
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
}'

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:
Paraméter
Típus
Érték
Leírás
Data
JSON string
egyedi értékek
Sikeres lekérdezés esetén tartalmazza a köteg (Batches) és tétel (Items) adatokat.
ResultCode
string
  • SUCCESSFUL (a pénzügyi visszatérítési elszámolás lekérdezése sikeres volt)
Hiba esetén a következő eredménykódok jelölik a hiba okát:
  • FunctionNotImplemented
  • InactiveStore
  • MissingParameter
  • MissingRemoteAddress
  • UnauthorizedAccess
  • UnauthorizedRemoteAddress
  • UnknownProvider
  • UnknownProviderForStore
  • UnknownStore
  • WrongApikey
  • WrongParameter
Jelzi a visszatérítési elszámolás lekérdezésének eredményét.
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.

Mintakód

A fenti SettlementRefund kérésre adott válasz:
{
"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"
}