|
POST |
https://onlinepenztarca.hu/api/v1/trans/create/lite |
igen |
Elfogadó/kibocsájtó |
Leírás
Ez az API hívás több oldalról használható, első fontos tulajdonsága, hogy képes ellátni elfogadó és kibocsájtó szerepet is.
A másik, hogy mind a két jogosultságnak megfelelően lehet használni, tehát kibocsájtóként is beépíthetjük, de mindössze csak az elfogadó tulajdonságát
tudjuk kihasználni. Kibocsájtóként pedig teljesértékűen.
Paraméter |
Típus |
Kötelező |
Megjegyzés |
user |
array |
igen |
Vásárló adatai, ezekből az email és a firstName a kötelező. |
order |
array |
igen |
A megrendelés alap adatai. |
cart |
array/bool |
nem |
Ennek a paraméternek 3 típusa van:
array: Termékek felsorolása a szűrővel ellátott kampányok miatt.
false: Ha nem szereténk hogy kibocsájtás történjen. Fontos: nem termékenként, hanem a cart paraméternek kell beállítani("cart:false,")!
true vagy üres vagy kihagyás: A rendszer kiszámolja és felgenerálja a felhasználónak(átmeneti állpotba) a tranzakciókat. Ebben az esetben csak a szűrővel nem rendelkezőket!
|
valueOfOpCoins |
int |
opcionális |
A vásárló onlinePénztárcájából felhasználni kívánt összeg. Ha fel akarunk használni a vásárló onlinePénztárcájából, akkor kötelező paraméter! Ha nem akarsz bajlódni a számolással egyszerűen add be a megrendelés összegét, mi úgy is újra átszámoljuk. |
Paraméter |
Típus |
Kötelező |
Megjegyzés |
user.email |
string |
igen |
A vásárló email címe. |
user.data.gender |
int |
nem |
A vásárló neme |
user.data.lastName |
string |
nem |
A vásárló vezetékneve |
user.data.firstName |
string |
igen |
A vásárló keresztneve |
user.data.birthday |
string |
nem |
A vásárló születésnapja |
user.data.zipCode |
string |
nem |
A vásárló irányítószáma |
order.id |
int |
igen |
A rendelés egyedi azonosítója. |
order.amount |
int |
igen |
A rendelés összege |
order.time |
string |
igen |
A rendelés leadásának pontos időpontja. Format: yyyy-mm-dd hh:mm:ss |
order.colleagueEmail |
string |
nem |
A munkatárs email címe. Kosárfolyamatban nem szükséges megadni, ugyanakkor a rendelés szerkesztése esetén javasolt!
|
cart.0.price |
int |
igen |
Itt be kell adnunk a termék árát, mert ha a kampány, a termék árához viszonyítva bocsájt ki (tehát százalékos),
akkor csak így tudjuk kiszámolni, hogy mennyi OP. jár érte.
|
cart.0.productId |
string |
igen |
A termék azonosítója, hogy a szűrővel ellátott kampányok is hozzá generálódjanak a rendeléshez.
Fontos, nem termékkódot hanem termék azonosítót kell megadni melyet a feed fájlban is elküldésre kerül.
|
{
"body":
{
"user":
{
"email":"colleague@email.com",
"data":
{
"gender":1,
"lastName":"Gipsz",
"firstName":"Jakab",
"birthday":"1993-1-06",
"zipCode":7624
}
},
"order":
{
"id":999,
"amount":100000,
"time":"2017-08-01 15:00:00",
"colleagueEmail":"colleague@email.com"
},
"cart":
{
"0":
{
"productId":7748,
"price":50000
},
"1":
{
"productId":7749,
"price":50000
}
},
"valueOfOpCoins":5000
}
}
{
"succes":true,
"returninfo":
{
"balance":304500,
"email":"email@example.com"
},
"applied":-5000
}
Paraméter |
Típus |
Megjegyzés |
success |
bool |
Siker esetén true, ellenkező esetben false |
returninfo.balance |
int |
A vásárló onlinePénztárcájának összege |
returninfo.email |
string |
A vásárló email címe |
applied |
int |
onlinePénztárcából beváltott összeg |
|
|
GET |
https://onlinepenztarca.hu/api/v1/order/payblock |
igen |
Elfogadó/kibocsájtó |
Leírás
Adott felhasználó egyenlege alapján legenerált html blokk. Funkciója az, hogy a kosár folyamatba a felhasználó be tudja pipálni és ezzel használhatja az onlinePénztárcát.
Paraméter |
Típus |
Kötelező |
Megjegyzés |
userEmail |
email |
igen |
Felhasználó email címe |
cartAmount |
int |
igen |
A kosár aktuális értéke |
{
"body":
{
"userEmail":"test@test.com",
"cartAmount":15000,
}
}
Sikeres |
Siker esetén egy teljes html blokk, hiba esetén pedig egy üres string tér vissza. |
|
|
POST |
https://onlinepenztarca.hu/api/v1/user/button |
igen |
Elfogadó |
Leírás
A köszönőoldalon biztosítani kell egy gomb megjelenítését!
3 gomb típus létezik, mindig a megadott helyzet függvénye, hogy melyik lesz megjelenítve.
-
A felhasználó nem létezik az online pénztárcában (regisztrációs link)
-
Rendelés alatt összeállított egyediv link
-
Regisztrációs kampány
-
Létező felhasználó fiók (belépési oldalra vezető link)
Paraméter |
Típus |
Kötelező |
Megjegyzés |
userEmail |
string |
igen |
Vásárló email címe |
orderId |
String |
igen |
A rendelés azonosítója |
{
"userEmail":"email@example.com",
"orderId":4563
}
{
{
"success": true,
"returnelements": {
"buttonType": 1,
"buttonIframe":
}
}
Paraméter |
Típus |
Megjegyzés |
success |
bool |
Siker esetén true, ellenkező esetben false. |
buttonType |
int |
A button típusa. |
buttonIframe |
string |
A gomb Iframe megjelenítése, itt nem szükséges verziókat kezelni, mert a megfelelő button fog megjelenni.
|
|
|
PUT |
https://onlinepenztarca.hu/api/v1/order/status/update |
igen |
Elfogadó |
Leírás
Lehetőségünk van egy rendeléshez tartozó tranzakciók állapotát updatelni. Például, ha egy rendeléshez tartozó
tranzakciók állapota visszaigazolásra vár állapotban van, akkor jóvá tudjuk írni a felhasználónak, amikor a rendelést visszaigazolják.
Itt egy trankzació állapotát tehetjük inaktív állapotba, ha éppen aktív.
Állapotok:
- 1: visszaigazolásra vár
- 2: visszaigazolt
- 4: visszamondott
Fontos: ha egy rendelést már visszamondtak akkor az már nem kerülhet újból semmilyen más állapotba.
Paraméter |
Típus |
Kötelező |
Megjegyzés |
orderId |
int |
igen |
Rendelés egyedi azonosítója |
status |
int |
igen |
Új állapot azonosítója |
colleagueEmail |
string |
igen |
Munkatárs email címe |
{
"body":
{
"orderId":"4563",
"status":"2",
"colleagueEmail":"colleague@email.com"
}
}
Paraméter |
Típus |
Megjegyzés |
success |
bool |
Siker esetén true, ellenkező esetben false. |
|
|
PUT |
https://onlinepenztarca.hu/api/v1/order/status/storno |
igen |
Elfogadó |
Leírás
Adott rendeléshez tartozó tranzakciók visszamondása. Alapvetően ha egy rendelés visszamondott állapotba kerül, akkor ezzel a hozzá kapcsolódó tranzakciókat visszamondott állapotba lehet állítani!
Fontos: ha egy rendelést már visszamondtak akkor az már nem kerülhet újból semmilyen más állapotba.
Paraméter |
Típus |
Kötelező |
Megjegyzés |
orderId |
int |
igen |
Rendelés egyedi azonosítója |
colleagueEmail |
string |
igen |
Munkatárs email címe |
{
"body":
{
"orderId":"4563",
"colleagueEmail":"colleague@email.com"
}
}
Paraméter |
Típus |
Megjegyzés |
success |
bool |
Siker esetén true, ellenkező esetben false. |
|
|
GET |
https://onlinepenztarca.hu/api/v1/order/calc |
igen |
Elfogadó |
Leírás
Segítségével egy általános számítást kapunk egy megadott összegre. Megkapjuk, hogy a felhasználótól függően és függetlenül is a számított értékeket!
Minden visszakapott adat pontosan leírásra kerül a response adatokban.
Paraméter |
Típus |
Kötelező |
Megjegyzés |
userEmail |
string |
igen |
Vásárló email címe |
valueOfOpCoins |
int |
opcionális |
A vásárló onlinePénztárcájából fizetni kívánt összeg |
orderAmount |
int |
igen |
A rendelés végösszege |
{
"body":
{
"userEmail":"email@example.com",
"valueOfOpCoins":"5000",
"orderAmount":"100000"
}
}
{
"success":true,
"calculatedData":
{
"maxRedeemValueWithoutUser":5000,
"priceWithDiscount":"95000",
"valueOfOpCoins":5000,
"numberOfOpCoins":10,
"userBalance":15000,
"maximumNumberOfOpCoin":10,
"maximumValueOfPaymentCampaign":10000,
"getOpCoin":500
}
}
Paraméter |
Típus |
Megjegyzés |
success |
bool |
Siker esetén true, ellenkező esetben false. |
calculatedData.maxRedeemValueWithoutUser |
int |
A megadott összeghez maximum elfogadható onlinePénztárca érték, függetlenül a megadott felhasználótól.
|
calculatedData.priceWithDiscount |
int |
Az összeg, ha levonjuk a paraméterként megadott onlinePénztárca értéket (valueOfOpCoins).
|
calculatedData.valueOfOpCoins |
int |
A maximális elfogadható onlinePénztárca érték a felhazsnálóhoz (valueOfOpCoins).
|
calculatedData.numberOfOpCoins |
int |
A megadott onlinePénztárca érték 500 Ft-os kuponok formájában átszámítva.
|
calculatedData.userBalance |
int |
A vásárló aktuális onlinePénztárca egyenlege.
|
calculatedData.maximumNumberOfOpCoin |
int |
A maximum elfogadható onlinePénztárca érték 500 Ft-os kuponok formájában átszámítva.
|
calculatedData.maximumValueOfPaymentCampaign |
int |
Az elfogadás értékhatára. Ez határozza meg, hogy mekkora összegenként fogadunk el 500 Ft-ot.
|
calculatedData.getOpCoin |
int |
Az elfogadás értékhatára. Megkapjuk, hogy mekkora összeget fogadunk el kuponok formájában. Ez fix adat, mindenkinek egységesen 500 és nem lehet módosítani!
|
|