Informace
Ako pozivate storniranje plaćanja putem Cloud API-ja, potrebno je kreirati zadatak za uređaj (TID) na kojem je plaćanje izvorno izvršeno. Pozivanje storniranja plaćanja izvršenog na terminalu "A" na terminalu "B" trenutno nije podržano.
Otkazivanje transakcije osnovna je platna operacija koja vam omogućuje otkazivanje prethodno obrađene transakcije do 93 dana nakon izvorne transakcije. Otkazivanje transakcije može se izvršiti bez korisničke kartice - sredstva će se automatski vratiti na karticu korištenu za izvornu prodajnu transakciju.
Prijava i autentifikacija
Sve nejavne krajnje točke zahtijevaju autentifikaciju pomoću JWT tokena. Token (s vijekom trajanja od 90 dana) možete dobiti putem krajnje točke /cloud/oauth/token sa sljedećim argumentima:
- Osnovna autentifikacija za krajnje točke tokena (ime/lozinka) – bit će osigurana za svakog korisnika.
- Korisničko ime trgovca – isto kao i za GP tom
- Lozinka trgovca – ista kao i za GP tom
- ID terminala (TID) – ID ciljnog terminala
- Krajnja točka autorizacije nalazi se na:
Dobivanje pristupnog tokena
Primjer zahtjeva:
POST {{apiCloudHost}}/cloud/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=password&username=jan.novak@example.com&password=ABCDEFGHIJKL&tid=999888
Primjer odgovora:
{
"access_token": "eyJh…", // access token used in authenticated API requests
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Oporavak tokena
Nakon isteka access_tokena, dostupan je refresh_token.
Primjer zahtjeva:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Vrsta sigurnosne sheme
HTTP autorizacijska shema
HTTP
bearer
Izrada zadatka
Pozovite POST krajnju točku /v1/tasks/TRANSACTION i upotrijebite CreateCloudTaskTransactionApiRequest sa sljedećim popunjenim podacima za stvaranje zahtjeva:
Varijabla
apiKey
OBAVEZNO
OBAVEZNO
tid
OBAVEZNO
OBAVEZNO
initiator
OBAVEZNO
OBAVEZNO
title
OBAVEZNO
OBAVEZNO
isprintaj po uplati
amount
OBAVEZNO
OBAVEZNO
iznos
transactionOperation
originTransactionId
broj izvora
otkažiMod
OBAVEZNO
OBAVEZNO
transactionType*
OBAVEZNO
OBAVEZNO
kôd valute
timeToLive
Format
niz
niz
niz
niz
boolean
number
number
niz
niz
niz
niz
niz
niz
integer
Opis
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.
Ciljani TID za zadatak. TID = ID terminala, koji je jedinstven za svaki uređaj. Samo jedan TID može se koristiti istovremeno na svim instaliranim uređajima.
Opis inicijatora trebao bi biti jedinstven za svaku instancu podsustava koja može pokrenuti zadatak. Primjer: "poslužitelj XY" ili "Blagajnik 1"
Naziv zadatka koji ljudi mogu pročitati. Trebao bi sadržavati neku identifikaciju zadatka.
Příklad: „Faktura 37364FD platba“
Příklad: „Faktura 37364FD platba“
výchozí hodnota: true
True, ako račun treba ispisati na uređaju.
Poznámka: U mobilních telefonů se ujistěte, že je připojena Bluetooth tiskárna.
True, ako račun treba ispisati na uređaju.
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“.
ID transakcije koju treba otkazati. Nije null ako je način otkazivanja VOID i 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)
Vremensko ograničenje isteka zadatka u oblaku. Dopuštene su vrijednosti od sekundi.
Primjer
333W212J3
483590
Cash desk 12
Storno 36744
false
40000
NOT USED
VOID
FD283737333
OPTIONAL
OLDER_TRANSACTION
KARTA
CZK
10
Sadržaj odgovora [CloudTaskDetailApiResponse]:
Mogući kodovi odgovora su:
Odgovor
RC200
RC403
RC406
RC 502
Poruka
OK - Zadatak je registriran
Korisniku nije dopušteno registrirati posao na danom terminalu.
Zadatak nije prihvatljiv za zadani terminal.
Push notification nije poslana
Opis
Zadatak je uspješno kreiran i bit će obrađen.
Ako se vaši API podaci ne podudaraju s poslanom TID vrijednošću (na primjer, kada je vlasnik TID-a drugačiji).
To se obično događa kada TID ne može obraditi zahtjev.
Push notification nije poslano zbog kvara uzvodne usluge.
Što učiniti
Nastavite sa sljedećim korakom u tijeku transakcije.
Molimo provjerite jeste li unijeli ispravan TID i pokušajte ponovno.
Provjerite poruku o pogrešci.
U nastavku možete pronaći varijable korištene u odgovoru:
Varijabla
title
taskId
created
taskClass
status
initiator
contextId
payload
exceptionId
type
message
context
Format
niz
niz
niz
niz
niz
niz
niz
object
niz
niz
niz
niz
Opis
Naziv zadatka koji ljudi mogu pročitati. Koristi se iz vrijednosti zahtjeva.
Interní id tasku
Datum i vrijeme kada je zadatak kreiran.
Třída užitečného zatíženíMožné hodnoty: [TRANSACTION, BATCH, DUMMY]
Status zadatka u oblaku. Moguće vrijednosti: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Opis inicijatora na strani klijenta. Koristi se iz vrijednosti zahtjeva.
ID pogođenog ciljnog entiteta, ako postoji (transactionId / batchId)
Tijelo kontekstualnog zadatka - ovisno o taskClass
Pseudo-jedinstveni ID iznimke. Može poslužiti kao "ID podrške" koji korisnik može dati podršci kako bi istražila pogrešku.
Vrsta iznimke.
Izvješće o iznimci.
Kontekst iznimke. Više informacija.
Primjer
Invoice 36744
dFd3sda
TRANSACTION
STVORENO
Cash desk 12
{...}
FujIk6
VALIDATION_EXCEPTION
Password too weak
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
YES
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
RC403
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
RC406
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
RC502
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
Provjera statusa zadatka
U sljedećem koraku provjerit ćete status zadatka na krajnjoj točki GET /v1/tasks/{taskID} koristeći zahtjev koji uključuje:
Varijabla
taskId
Format
niz
Opis
ID zadatka koji ste primili kao dio prethodnog koraka.
Primjer
dFd3sda
Mogući povratni kodovi:
Odgovor
RC200
RC403
Poruka
OK - Dostupan status zadatka
Zadatak u oblaku nije pronađen za trenutni terminal.
Poruka
Ažuriranje statusa posla uspješno je obrađeno.
Trebali biste provjeriti svoj ID zadatka i ponovno poslati ispravnu vrijednost.
Opis
Ako ne dobijete konačni status (vidi dolje), ponovite ovaj korak.
Molimo provjerite jeste li unijeli ispravan ID zadatka i pokušajte ponovno.
Varijable u odgovoru:
Varijabla
title
taskId
created
taskClass
status
initiator
contextID
payload
exceptionId
type
message
context
Format
niz
niz
niz
niz
niz
niz
niz
niz
niz
niz
niz
Opis
Naziv zadatka koji ljudi mogu pročitati. Koristi se iz vrijednosti zahtjeva za stvaranje zadatka.
Interní ID tasku
Datum i vrijeme kada je zadatak kreiran.
Moguće vrijednosti: [TRANSACTION, BATCH, DUMMY]
Moguće vrijednosti: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Opis inicijatora na strani klijenta. Koristi se iz vrijednosti zahtjeva.
ID pogođenog ciljnog entiteta, ako postoji (transactionId / batchId)
Pseudo-jedinstveni ID iznimke. Može poslužiti kao "ID podrške" koji korisnik može dati podršci kako bi istražio potencijalni problem.
Vrsta iznimke.
Poruka o iznimci.
Kontekst iznimke - više informacija.
Primjer
Invoice 36744
dFd3sda
IN_PROGRESS
Cash desk 12
FujIk6
VALIDATION_EXCEPTION
Password too weak
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
YES
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
RC404
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
Zahtjev za status zadatka treba ponavljati dok se ne dobije jedan od konačnih kodova odgovora, a to su:
Status
INIT_ERROR
Završeno
OTKAZANO
ERROR
Opis
Proces plaćanja nije mogao biti pokrenut. Molimo provjerite poruku o pogrešci.
Kad dosegnete ovu fazu, vaš je zadatak dovršen i rezultat je dostupan.
Zadatak je otkazao korisnik.
Došlo je do pogreške tijekom obrade zadatka.
Što učiniti
Slijedite upute za pogrešku.
Můžete pokračovat dalším krokem.
Trebali biste započeti novi zadatak jer je korisnik otkazao ovaj zadatak.
Slijedite upute za pogrešku.
Možete prijeći na sljedeći korak samo ako je odgovor u statusu COMPLETED.
Dobijte rezultat plaćanja
Sada znamo da je transakcija autorizirana. Cilj ovog koraka je dobiti status transakcije i detalje transakcije. Za novi zahtjev, pozvat ćete GET krajnju točku /v1/transactions/{transactionId}, gdje ćete koristiti sljedeće varijable:
Varijabla
transactionId
Format
niz
Opis
ID transakcije koji ste dobili u prethodnim koracima.
Primjer
4414c640-2db7-11ec-910a-91880dadec20
Mogući kodovi odgovora su:
Odgovor
RC200
RC404
Poruka
OK - navedeni detalji transakcije
Za trenutni TID nije pronađena nijedna transakcija.
Poruka
Uspješan odgovor na vaš zahtjev.
Ovaj status se javlja kada zadani ID transakcije nije pronađen za vaš uređaj.
Opis
Transakcija je dovršena!
Provjerite ID transakcije.
Odgovor sadrži sljedeće varijable ovisno o kodu odgovora:
Varijabla
rezultat
responseMessage
transanctionId
transactionOperation
vrsta transakcije
ID trgovca
tid
kôd valute
amount
iznos
brojkartice
cardDataEntry
broj referencije
invoiceNumber
date
emvAppLabel
broj sekvence
exceptionId
type
message
context
dccData": {"status"}
Format
niz
niz
niz
niz
niz
niz
niz
niz
number
number
niz
niz
niz
niz
niz
niz
niz
niz
niz
niz
niz
niz
Opis
Rezultat transakcije, moguće vrijednosti [ ACCEPTED, DECLINED, CANCELLED ] gdje je:
ACCEPTED - transakcija je uspješno autorizirana
DECLINED - transakcija je iz nekog razloga odbijena
CANCELLED - ako je transakciju otkazao operater ili korisnik
ACCEPTED - transakcija je uspješno autorizirana
DECLINED - transakcija je iz nekog razloga odbijena
CANCELLED - ako je transakciju otkazao operater ili korisnik
Detaljniji opis rezultirajuće vrijednosti.
Interní ID úkolu
Moguće vrijednosti: ""SALE"" ""VOID"" ""REFUND""
Vrsta operacije/transakcije.
Vrsta operacije/transakcije.
Moguće vrijednosti: "CASH" "CARD"
Samo za transakcije karticama - ID poslovnice.
ID transakcije koji je kreirao terminal
Kod valute (ISO 4217)
Iznos transakcije s 2 decimalna mjesta (400 CZK).
Iznos napojnice unesen je na 2 decimale (30 CZK).
Broj maskirane kartice.
Způsob načtení karty - mag.proužek, čip nebo contactless.
Referentni broj transakcije preuzet iz vrijednosti zahtjeva za zadatak: originReferenceNum
Datum i vrijeme autorizacije transakcije
Marka EMV kartice preuzeta iz podataka kartice
Broj generiran na strani GP-a
Pseudo-jedinstveni ID iznimke. Može poslužiti kao "ID podrške" koji korisnik može dati podršci za istragu.
Vrsta iznimke.
Poruka o iznimci.
Kontekst iznimke - više informacija.
HR: Označava otkazuje li se DCC transakcija.
EN: Gives iformation whether voided transaction was processed as DCC
EN: Gives iformation whether voided transaction was processed as DCC
Primjer
ACCEPTED
null
4414c640-2db7-11ec-910a-91880dadec20
VOID
KARTA
343382001
483591
40000
-
1233
null
FD123456
2020-09-16T09:31:16.000Z
null
102304128
FujIk6
VALIDATION_EXCEPTION
Password too weak
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
Ako je ACCEPTED, na računu morate napisati sljedeći tekst:
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
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
YES
RC 404
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES
NO
Ako ćete sami generirati ili ispisati račun, preporučujemo da provjerite koja su polja obavezna i moraju se ispisati/prikazati na računu. Opis je dostupan ovdje.