Informace
Pokud skrze Cloud API voláte storno platby, je nezbytné vytvořit task pro zařízení (TID), kde byla platba původně provedena. Volání storna platby provedené na terminálu „A“ na terminálu „B“ není aktuálně podporováno.
Storno transakce je základní platební operace, která umožňuje zrušit dříve zpracovanou transakci až 93 dnů od původní transakce. Zrušení transakce lze provést bez zákaznické karty – prostředky budou automaticky vráceny na kartu použitou pro původní transakci typu prodej.
Bejelentkezés és hitelesítés
Minden nem nyilvános végpont esetében JWT-token hitelesítésre van szükség. A token (90 napos élettartammal) a /cloud/oauth/token végponton keresztül érhető el a következő argumentumok megadásával:
- Alapszintű hitelesítés a token végpontokhoz (név/jelszó) - minden felhasználó számára biztosított.
- Kereskedő felhasználónév - ugyanaz, mint a GP tom esetében
- Kereskedői jelszó - ugyanaz, mint a GP tom esetében
- Terminal ID (TID) - a célterminál azonosítója.
- Az engedélyezési végpont a következő címen található:
Hozzáférési token megszerzése
Példa kérés:
POST {{apiCloudHost}}/cloud/oauth/token
Engedélyezés: Alapvető YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=jan.novak@example.com&password=ABCDEFGHIJKL&tid=999888
Példa válaszra:
{
"access_token": "eyJh...", // hitelesített API-kérésekben használt hozzáférési token
"token_type": "bearer",
"refresh_token": "GciO...",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Egy token megújítása
Amikor a access_token lejár, egy refresh_token áll rendelkezésre.
Példa kérés:
POST {{apiHost}}/api/oauth/token
Engedélyezés: Alapvető YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO...
GPTomAuth
A biztonsági rendszer típusa
HTTP engedélyezési séma
HTTP
hordozó
Táska létrehozása
Hívja meg a /v1/tasks/TRANSACTION POST végpontot, és használja a CreateCloudTaskTransactionApiRequest funkciót a következő információk kitöltésével a kérelem létrehozásához:
Változó
apiKey
KÖTELEZŐ
KÖTELEZŐ
tid
KÖTELEZŐ
KÖTELEZŐ
kezdeményező
KÖTELEZŐ
KÖTELEZŐ
cím
KÖTELEZŐ
KÖTELEZŐ
printByPaymentApp
összeg
KÖTELEZŐ
KÖTELEZŐ
TipAmount
transactionOperation
originTransactionId
originReferenceNum
cancelMode
KÖTELEZŐ
KÖTELEZŐ
transactionType*
KÖTELEZŐ
KÖTELEZŐ
currencyCode
timeToLive
Formátum
string
string
string
string
boolean
szám
szám
string
string
string
string
string
string
Egész szám
Leírás
API key naleznete přímo v aplikaci v sekci Účet-Cloud API. Používá se k rozlišení přihlášení hlavně v Cloud API.
A feladat cél-TID-je. TID = terminál azonosító, amely minden eszközön egyedi. Egyszerre csak egy TID használható az összes telepített eszközön.
A kezdeményező leírásának minden olyan alrendszerpéldány esetében egyedinek kell lennie, amely feladatot kezdeményezhet. Példa: „XY szerver“ vagy „Checkout 1“.“
Ember által olvasható feladatcím. Tartalmaznia kell a feladat valamilyen azonosítóját.
Příklad: „Faktura 37364FD platba“
Příklad: „Faktura 37364FD platba“
výchozí hodnota: true
Igaz, ha a nyugtát ki kell nyomtatni a készülékre.
Poznámka: U mobilních telefonů se ujistěte, že je připojena Bluetooth tiskárna.
Igaz, ha a nyugtát ki kell nyomtatni a készülékre.
Poznámka: U mobilních telefonů se ujistěte, že je připojena Bluetooth tiskárna.
Částka transakce, která má být zrušena, musí být nenulová a zahrnuje desetinná místa.
Pro storno se nepoužívá.
Typ transakce tasku. U transakce „Storno transakce“ vyplníte hodnotu „VOID“.
A törlendő tranzakció azonosítója. Nem null, ha az üzemmód VOID és a törlés OLDER_TRANSACTION.
Nechcete-li tuto hodnotu tisknout na účtenku, ponechte prázdné.
Možné hodnoty: [ LAST_TRANSACTION, OLDER_TRANSACTION ] kde:
LAST_TRANSACTION - používá se pouze pro dříve autorizovanou transakci. Mezi tímto úkolem a předchozím prodejním úkolem nemůže být žádný jiný požadavek.
OLDER_TRANSACTION – používá se pro všechny starší transakce kromě poslední transakce.
LAST_TRANSACTION - používá se pouze pro dříve autorizovanou transakci. Mezi tímto úkolem a předchozím prodejním úkolem nemůže být žádný jiný požadavek.
OLDER_TRANSACTION – používá se pro všechny starší transakce kromě poslední transakce.
Možné hodnoty: [ CASH, CARD ]
3 znaky pro kód měny (ISO 4217)
A felhőfeladat lejárati határideje. A másodperc közötti intervallumban adhat meg értékeket.
Példa
333W212J3
483590
Pénztár 12
Storno 36744
hamis
40000
NEM HASZNÁLTAK
VOID
FD283737333
OPTIONAL
OLDER_TRANSACTION
KÁRTYA
CZK
10
A [CloudTaskDetailApiResponse] tartalma:
A lehetséges válaszkódok a következők:
Válasz
RC200
RC403
RC406
RC 502
Jelentés
OK - A feladatot regisztrálták
A felhasználó nem regisztrálhat munkát a terminálon
A feladat nem elfogadható a terminál számára
Nem küldött Push-értesítés
Leírás
A feladatot sikeresen létrehoztuk és feldolgozzuk.
Ha az API hitelesítő adatai nem egyeznek az elküldött TID-értékkel (például ha a TID tulajdonosa nem azonos).
Ez általában akkor fordul elő, ha a TID nem tudja feldolgozni a kérelmet.
A Push-értesítés nem került elküldésre az upstream szolgáltatás hibája miatt.
Hogyan viselkedjünk
Folytassa a tranzakciófolyam következő lépésével.
Ellenőrizze, hogy a helyes TID-et adta-e meg, és próbálja meg újra.
Ellenőrizze a hibaüzenetet.
Az alábbiakban a válaszban használt változókat ismertetjük:
Változó
cím
taskId
létrehozott
taskClass
státusz
kezdeményező
contextId
hasznos teher
exceptionId
típus
üzenet
kontextus
Formátum
string
string
string
string
string
string
string
objektum
string
string
string
string
Leírás
A táska ember által olvasható neve. A kérés értékéből használatos.
A táska belső azonosítója
A táska létrehozásának dátuma és időpontja.
Payload classLehetséges értékek: [TRANSACTION, BATCH, DUMMY]
Felhőzsák státusz. Lehetséges értékek: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Ügyféloldali kezdeményező leírása. A kérés értékéből használatos.
Az érintett célszervezet azonosítója, ha van ilyen (transactionId / batchId)
Kontextusfeladat teste - a taskClass-tól függően
Pszeudo-egyedi kivételazonosító. Szolgálhat „támogatási azonosítóként“, amelyet a felhasználó a hiba kivizsgálásához meg tud adni a támogatásnak.
Kivétel típusa.
Mentességi jelentés.
A kivétel kontextusa. További információk.
Példa
36744 számla
dFd3sda
TRANSACTION
KÉSZÜLT
Pénztár 12
{...}
FujIk6
VALIDATION_EXCEPTION
Túl gyenge jelszó
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
NO
NO
NO
NO
RC403
NO
NO
NO
NO
NO
NO
NO
NO
IGEN
IGEN
IGEN
IGEN
RC406
NO
NO
NO
NO
NO
NO
NO
NO
IGEN
IGEN
IGEN
IGEN
RC502
NO
NO
NO
NO
NO
NO
NO
NO
IGEN
IGEN
IGEN
IGEN
Ellenőrizze a táska állapotát
A következő lépésben a GET /v1/tasks/{taskID} végponton ellenőrizni fogja a feladat állapotát egy olyan kéréssel, amely a következőket tartalmazza:
Változó
taskId
Formátum
string
Leírás
Az előző lépésben kapott táska azonosítója.
Példa
dFd3sda
Lehetséges visszatérési kódok:
Válasz
RC200
RC403
Jelentés
OK - A zsák állapota elérhető
Az aktuális terminálhoz nem találtak felhőmunkát.
Jelentés
A feladat állapotfrissítése sikeresen megtörtént.
Ellenőrizze a taskID-t, és küldje be újra a helyes értéket.
Leírás
Ha nem kapja meg a végleges státuszt (lásd alább), ismételje meg ezt a lépést.
Ellenőrizze, hogy a helyes taskID-t adta-e meg, és próbálja meg újra.
Válaszváltozók:
Változó
cím
taskId
létrehozott
taskClass
státusz
kezdeményező
contextID
hasznos teher
exceptionId
típus
üzenet
kontextus
Formátum
string
string
string
string
string
string
string
string
string
string
string
Leírás
Ember által olvasható feladatcím. A feladat létrehozására irányuló kérelem értékéből használatos.
Belső táska azonosító
A táska létrehozásának dátuma és időpontja.
Lehetséges értékek: [TRANSACTION, BATCH, DUMMY]
Lehetséges értékek: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Ügyféloldali kezdeményező leírása. A kérés értékéből használatos.
Az érintett célszervezet azonosítója, ha van ilyen (transactionId / batchId)
Pszeudo-egyedi kivételazonosító. Szolgálhat „támogatási azonosítóként“, amelyet a felhasználó meg tud mondani a támogatásnak a lehetséges probléma kivizsgálásához.
Kivétel típusa.
Kivételes jelentés.
Mentességi kontextus - további információk.
Példa
36744 számla
dFd3sda
IN_PROGRESS
Pénztár 12
FujIk6
VALIDATION_EXCEPTION
Túl gyenge jelszó
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
NO
NO
NO
NO
RC404
NO
NO
NO
NO
NO
NO
NO
NO
IGEN
IGEN
IGEN
IGEN
A zsák állapotára vonatkozó kérést addig kell ismételni, amíg meg nem kapjuk a végső válaszkódok egyikét, amelyek a következők:
Állapot
INIT_ERROR
TELJESÍTETT
ELMARADÓ
HIBA
Leírás
A fizetési folyamat kezdeményezése sikertelen volt. Ellenőrizze a kapott hibát.
Amint megkapja ezt az állapotot, a feladatot elvégezte, és az eredmény elérhető.
A feladatot a felhasználó törölte.
A feladat feldolgozása során hiba történt.
Hogyan viselkedjünk
Kövesse a hibára vonatkozó utasításokat.
Folytathatja a következő lépéssel.
Új feladatot kell indítania, mert ezt a feladatot a felhasználó törölte.
Kövesse a hibára vonatkozó utasításokat.
Csak akkor léphet tovább a következő lépésre, ha a válasz KÉSZ állapotú.
A fizetési eredmény elérése
Most már tudjuk, hogy a tranzakciót engedélyezték. Ennek a lépésnek az a célja, hogy megkapjuk a tranzakció státuszát és részleteit. Az új kéréshez a /v1/transactions/{transactionId} GET végpontot hívja meg a következő változókkal:
Változó
transactionId
Formátum
string
Leírás
Az előző lépések során kapott tranzakcióazonosító.
Példa
4414c640-2db7-11ec-910a-91880dadec20
A lehetséges válaszkódok a következők:
Válasz
RC200
RC404
Jelentés
OK - tranzakció adatai megadva
Az aktuális TID-hez nem találtak tranzakciót.
Jelentés
Sikeres válasz a kérésére.
Ez a feltétel akkor lép fel, ha a tranzakcióazonosító nem található az Ön készülékéhez.
Leírás
A tranzakció befejeződött!
Ellenőrizze a tranzakció azonosítóját.
A válasz a válaszkódtól függően a következő változókat tartalmazza:
Változó
eredmény
responseMessage
transanctionId
transactionOperation
transactionType
merchantID
tid
currencyCode
összeg
TipAmount
cardNumber
cardDataEntry
referenceNumber
invoiceNumber
dátum
emvAppLabel
sequenceNumber
exceptionId
típus
üzenet
kontextus
dccData": {"status"}
Formátum
string
string
string
string
string
string
string
string
szám
szám
string
string
string
string
string
string
string
string
string
string
string
string
Leírás
Výsledek transakce, možné hodnoty [ ACCEPTED, DECLINED, CANCELLED ] kde:
ACCEPTED - transakce byla úspěšně autorizována
DECLINED - transakce byla zamítnuta z nějakého důvodu
CANCELLED - pokud je transakce zrušena obsluhou nebo zákazníkem
ACCEPTED - transakce byla úspěšně autorizována
DECLINED - transakce byla zamítnuta z nějakého důvodu
CANCELLED - pokud je transakce zrušena obsluhou nebo zákazníkem
A kapott érték részletesebb leírása.
Belső feladat azonosítója
Lehetséges értékek: ""ELADÓ"" ""érvénytelen"" ""VISSZAFIZETÉS""
Művelet / tranzakció típusa."
Művelet / tranzakció típusa."
Lehetséges értékek "KÉSZPÉNZ" "KÁRTYA"
Csak kártyás tranzakciók esetén - Fióktelep azonosító.
A terminál által létrehozott tranzakció azonosítója
Valutakód (ISO 4217)
Tranzakció összege 2 tizedesjegy pontossággal (400 CZK).
A borravaló összege 2 tizedesjegy pontossággal (30 CZK).
Maszkolt kártyaszám.
Způsob načtení karty - mag.proužek, čip nebo contactless.
A tranzakció hivatkozási száma a kérési feladat értékéből: originReferenceNum
A tranzakció engedélyezésének dátuma és időpontja
A kártya EMV márkája a kártya adataiból
A GP oldalán generált szám
Pszeudo-egyedi kivételazonosító. Szolgálhat „támogatási azonosítóként“, amelyet a felhasználó megmondhatja a támogatásnak, hogy vizsgálja ki.
Kivétel típusa
Kivételes jelentés
Mentességi kontextus - további információk.
CZ: Udává informaci, zda se stornuje DCC transakce
EN: Gives iformation whether voided transaction was processed as DCC
EN: Gives iformation whether voided transaction was processed as DCC
Példa
ELFOGADVA
null
4414c640-2db7-11ec-910a-91880dadec20
VOID
KÁRTYA
343382001
483591
40000
-
1233
null
FD123456
2020-09-16T09:31:16.000Z
null
102304128
FujIk6
VALIDATION_EXCEPTION
Túl gyenge jelszó
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
CZ: Pokud ACCEPTED, je potřeba na účtenku dát text:
EN: If ACCEPTED, you need to put on your receit following text:
The transaction amount, currency and the exchange rate are the same as for the original transaction.
The currency conversion is provided by Global Payments.
EN: If ACCEPTED, you need to put on your receit following text:
The transaction amount, currency and the exchange rate are the same as for the original transaction.
The currency conversion is provided by Global Payments.
RC 200
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
IGEN
NO
NO
NO
NO
IGEN
RC 404
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
IGEN
IGEN
IGEN
IGEN
NO
Pokud budete účtenku generovat nebo tisknout na své straně, doporučujeme zkontrolovat, která pole jsou povinná a musí být vytištěna/zobrazena na účtence. Popis je k dispozici zde.