Czym dokładnie jest wsad? Każda utworzona transakcja należy do partii. Podobnie jak paragon, każda partia ma numer i jest w rzeczywistości pakietem transakcji. Zamknięcie to operacja administracyjna, w ramach której terminal zamyka partię i monituje systemy o zamknięcie partii i otwarcie nowej. W systemach Global Payments możliwe jest wyświetlenie numeru zamknięcia dla każdej transakcji i możliwe jest filtrowanie transakcji według tego numeru.
Logowanie i uwierzytelnianie
Uwierzytelnianie tokenem JWT jest wymagane dla wszystkich niepublicznych punktów końcowych. Token (o okresie ważności 90 dni) jest uzyskiwany za pośrednictwem punktu końcowego /cloud/oauth/token z następującymi argumentami:
- Podstawowe uwierzytelnianie dla punktów końcowych tokena (nazwa/hasło) - zostanie zapewnione dla każdego użytkownika.
- Nazwa użytkownika tradera - taka sama jak w przypadku GP Tom
- Hasło tradera - takie samo jak w przypadku GP Tom
- Identyfikator terminala (TID) - identyfikator terminala docelowego
- Punkt końcowy autoryzacji znajduje się pod adresem:
Uzyskiwanie tokenu dostępu
Przykładowe żądanie:
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
Przykładowa odpowiedź:
{
"access_token": "eyJh…", // access token used in authenticated API requests
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Odnawianie tokena
Po wygaśnięciu access_token dostępny jest refresh_token.
Przykładowe żądanie:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Typ systemu zabezpieczeń
Schemat autoryzacji HTTP
HTTP
okaziciel
Tworzenie torby
Wywołaj punkt końcowy POST /v1/tasks/BATCH i użyj CreateCloudTaskTransactionApiRequest z wypełnionymi następującymi informacjami, aby utworzyć żądanie:
Zmienna
data
OBOWIĄZKOWE
OBOWIĄZKOWE
apiKey
OBOWIĄZKOWE
OBOWIĄZKOWE
tid
OBOWIĄZKI
OBOWIĄZKI
inicjator
OBOWIĄZKI
OBOWIĄZKI
tytuł
OBOWIĄZKOWE
OBOWIĄZKOWE
timeToLive (czas na życie)
Format
ciąg
ciąg
ciąg
ciąg
ciąg
liczba całkowita
Opis
Transakcje z wcześniejszą lub tą samą datą zostaną zamknięte. Uwzględnione zostaną wszystkie transakcje do tej daty od ostatniej pomyślnie zamkniętej partii.
Klucz API można znaleźć w aplikacji w sekcji Account-Cloud API. Służy on do rozróżniania loginów głównie w Cloud API.
Docelowy identyfikator TID dla zadania. TID = Identyfikator terminala, który jest unikalny dla każdego urządzenia. Tylko jeden identyfikator TID może być używany jednocześnie na wszystkich zainstalowanych urządzeniach.
Opis inicjatora powinien być unikalny dla każdej instancji podsystemu, która może zainicjować zadanie. Przykład: "Server XY" lub "Checkout 1".
Czytelna dla człowieka nazwa worka. Powinna ona zawierać pewną identyfikację zadania.
Przykład: "Invoice 37364FD".
Przykład: "Invoice 37364FD".
Limit pro vypršení platnosti cloudové úlohy. Je povoleno zadat hodnoty z intervalu <10 až 172800> sekund.
Przykład
2025-12-18T08:21:39.427Z
333W212J3
483590
Kasa 12
Termin 36744
10
Treść odpowiedzi [CloudTaskDetailApiResponse]:
Możliwe kody odpowiedzi to:
Odpowiedź
RC200
RC403
RC406
RC 502
Raport
OK - zadanie zostało zarejestrowane
Użytkownik nie może zarejestrować zadania na terminalu
Zadanie nie jest akceptowalne dla terminala
Powiadomienie push nie zostało wysłane
Opis
Zadanie zostało pomyślnie utworzone i zostanie przetworzone.
Jeśli poświadczenia API nie są zgodne z wysłaną wartością TID (na przykład, jeśli właściciel TID jest inny).
Zwykle ma to miejsce, gdy TID nie jest w stanie przetworzyć żądania.
Powiadomienie push nie zostało wysłane z powodu awarii usługi upstream.
Jak się zachować
Przejdź do następnego kroku w przepływie transakcji.
Sprawdź, czy wpisałeś prawidłowy identyfikator TID i spróbuj ponownie.
Sprawdź komunikat o błędzie.
Poniżej znajdują się zmienne użyte w odpowiedzi:
Zmienna
tytuł
taskId
stworzony
taskClass
status
inicjator
contextId
ładunek
exceptionId
typ
wiadomość
kontekst
Format
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
obiekt
ciąg
ciąg
ciąg
ciąg
Opis
Czytelna dla człowieka nazwa worka. Używana z wartości żądania.
Wewnętrzny identyfikator torby
Data i godzina utworzenia torby.
Klasa ładunkuMożliwe wartości: [TRANSACTION, BATCH, DUMMY]
Status torby w chmurze. Możliwe wartości: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR].
Opis inicjatora po stronie klienta. Używany z wartości żądania.
Identyfikator podmiotu docelowego, którego dotyczy transakcja, jeśli dotyczy (transactionId / batchId)
Treść zadania kontekstowego - w zależności od taskClass
Pseudo-unikalny identyfikator wyjątku. Może służyć jako "identyfikator wsparcia", który użytkownik może przekazać pomocy technicznej w celu zbadania błędu.
Typ wyjątku.
Raport o zwolnieniu.
Kontekst wyjątku. Dalsze informacje.
Przykład
Zamknięcie 123
dFd3sda
BATCH
UTWORZONY
Kasa 12
{...}
FujIk6
VALIDATION_EXCEPTION
Zbyt słabe hasło
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
TAK
TAK
TAK
TAK
TAK
TAK
TAK
TAK
NIE
NIE
NIE
NIE
RC403
NIE
NIE
NIE
NIE
NIE
NIE
NIE
NIE
TAK
TAK
TAK
TAK
RC406
NIE
NIE
NIE
NIE
NIE
NIE
NIE
NIE
TAK
TAK
TAK
TAK
RC502
NIE
NIE
NIE
NIE
NIE
NIE
NIE
NIE
TAK
TAK
TAK
TAK
Sprawdź stan torby
V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:
Zmienna
taskId
Format
ciąg
Opis
Identyfikator torby otrzymanej w poprzednim kroku.
Przykład
dFd3sda
Możliwe kody zwrotne:
Odpowiedź
RC200
RC403
Raport
OK - status torby dostępny
Nie znaleziono zadania w chmurze dla bieżącego terminala.
Raport
Aktualizacja statusu zadania została pomyślnie przetworzona.
Powinieneś sprawdzić swój taskID i ponownie przesłać poprawną wartość.
Opis
Jeśli nie otrzymasz statusu końcowego (patrz poniżej), powtórz ten krok.
Sprawdź, czy wpisałeś prawidłowy identyfikator zadania i spróbuj ponownie.
Zmienne odpowiedzi:
Zmienna
tytuł
taskId
stworzony
taskClass
status
inicjator
contextID
ładunek
exceptionId
typ
wiadomość
kontekst
Format
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
Opis
Czytelny dla człowieka tytuł zadania. Używany z wartości żądania utworzenia zadania.
Wewnętrzny identyfikator torby
Data i godzina utworzenia torby.
Możliwe wartości: [TRANSACTION, BATCH, DUMMY]
Możliwe wartości: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR].
Opis inicjatora po stronie klienta. Używany z wartości żądania.
Identyfikator podmiotu docelowego, którego dotyczy transakcja, jeśli dotyczy (transactionId / batchId)
Pseudo-unikalny identyfikator wyjątku. Może służyć jako "identyfikator wsparcia", który użytkownik może przekazać pomocy technicznej w celu zbadania potencjalnego problemu.
Typ wyjątku.
Raport o wyjątkach.
Kontekst zwolnienia - dalsze informacje.
Przykład
Faktura 36744
dFd3sda
2025-12-18T08:21:39.427Z
BATCH
IN_PROGRESS
Kasa 12
12DFSFSSF
FujIk6
VALIDATION_EXCEPTION
Zbyt słabe hasło
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
TAK
TAK
TAK
TAK
TAK
TAK
TAK
TAK
NIE
NIE
NIE
NIE
RC404
NIE
NIE
NIE
NIE
NIE
NIE
NIE
NIE
TAK
TAK
TAK
TAK
Zapytanie o stan torby należy powtarzać aż do uzyskania jednego z końcowych kodów odpowiedzi, którymi są:
Status
INIT_ERROR
ZAKOŃCZONE
ODWOŁANE
BŁĄD
Opis
Inicjacja procesu płatności nie powiodła się. Sprawdź otrzymany błąd.
Otrzymanie tego statusu oznacza, że zadanie zostało ukończone, a jego wynik jest dostępny.
Zadanie zostało anulowane przez użytkownika.
Podczas przetwarzania zadania wystąpił błąd.
Jak się zachować
Postępuj zgodnie z instrukcjami dotyczącymi błędu.
Możesz przejść do następnego kroku.
Należy rozpocząć nowe zadanie, ponieważ to zadanie zostało anulowane przez użytkownika.
Postępuj zgodnie z instrukcjami dotyczącymi błędu.
Możesz przejść do następnego kroku tylko wtedy, gdy odpowiedź jest w stanie COMPLETED.
Uzyskanie wyniku zamknięcia
Nyní víme, že uzávěrka byla autorizována. Cílem tohoto kroku je získat stav uzávěrky a její údaje. Pro nový požadavek zavoláte koncový bod GET /v1/batches/{batchId}, kde použijete následující proměnné:
Zmienna
batchId
Format
ciąg
Opis
Identyfikator partii uzyskany w poprzednich krokach.
Przykład
12DFSFSSF
Możliwe kody odpowiedzi to:
Odpowiedź
RC200
RC404
Raport
OK - podano szczegóły zamknięcia
Nie znaleziono zamknięcia dla bieżącego TID.
Raport
Pomyślna odpowiedź na wniosek o zamknięcie.
Ten stan występuje, gdy dany identyfikator Deadline ID nie został znaleziony dla urządzenia.
Opis
Transakcja została zakończona!
Sprawdź identyfikator transakcji.
Odpowiedź zawiera następujące zmienne w zależności od kodu odpowiedzi:
Zmienna
batchid
communicationId
batchNumber
data
previousBatchDate
firstTransactionDate
totalAmount
waluta
totalCount
saleCount
saleAmount
voidCount
voidAmount
invalidCount
amsBatchNumber
subBatches
Format
ciąg
ciąg
ciąg
ciąg
ciąg
ciąg
liczba
ciąg
liczba
liczba
liczba
liczba
liczba
liczba
ciąg
obiekt
Opis
Wewnętrzny identyfikator partii, OPEN dla pseudo partii z otwartymi transakcjami.
Może być używany do pomocy technicznej. Pseudo-unikalny identyfikator do celów rejestrowania.
Numer partii dla identyfikatora TID.
Dokładna data i godzina zamknięcia partii.
Data i godzina rozpoczęcia zamkniętej partii. Masz okres czasu dla tej partii (OD: wartość previousBatchDate DO: wartość daty).
Data najstarszej transakcji.
Łączna kwota dla wszystkich typów transakcji.
Waluta zamknięcia
Całkowita liczba transakcji w partii
Liczba transakcji danego typu sprzedaży w partii.
Wolumen transakcji typu sprzedaż w partii.
Liczba wszystkich transakcji anulowania w partii.
Wolumen wszystkich transakcji anulowania w partii.
Liczba nieprawidłowych transakcji w partii
Wewnętrzny identyfikator partii, OPEN dla pseudo partii z otwartymi transakcjami.
Świadczenia podstawowe w ramach metazasiłku - podział według typu transakcji i zawiera informacje statystyczne na temat świadczeń podrzędnych według typu metody płatności. Obejmuje:
-closeBatchNumber (string) - closeBatchNumber partii podrzędnej
- totalCount (number) - całkowita liczba transakcji w partii
- saleCount (number) - liczba transakcji typu sprzedaż w partii
- saleAmount (number) - wolumen transakcji typu sprzedaż w partii
- voidCount (number) - liczba anulowanych transakcji
- voidAmount (number) - wolumen anulowanych transakcji w partii
-closeBatchNumber (string) - closeBatchNumber partii podrzędnej
- totalCount (number) - całkowita liczba transakcji w partii
- saleCount (number) - liczba transakcji typu sprzedaż w partii
- saleAmount (number) - wolumen transakcji typu sprzedaż w partii
- voidCount (number) - liczba anulowanych transakcji
- voidAmount (number) - wolumen anulowanych transakcji w partii
Przykład
12DFSFSSF
2
2025-12-18T08:21:39.427Z
2025-12-17T12:22:11.427Z