Ce este mai exact o doză? Fiecare tranzacție pe care o creați aparține unui așa-numit lot. Ca o chitanță, fiecare lot are propriul număr și este de fapt un pachet de tranzacții. O întrerupere este o operațiune administrativă prin care un terminal închide un lot și solicită sistemelor să închidă lotul și să deschidă unul nou. În Global Payments, este posibil să vedeți numărul de închidere pentru fiecare tranzacție și este posibil să filtrați tranzacțiile după acest număr.
Autentificare & Autentificare
Autentificarea simbolului JWT este necesară pentru toate punctele finale non-publice. Obțineți simbolul (cu o durată de viață de 90 de zile) prin punctul final /cloud/oauth/token cu următoarele argumente furnizate:
- Autentificarea de bază pentru punctele finale ale tokenului (nume/parolă) - va fi furnizată pentru fiecare utilizator.
- Numele de utilizator al comerciantului – la fel ca pentru GP tom
- Parola comerciantului – la fel ca pentru GP tom
- ID terminal (TID) – ID terminal de destinație
- Punctul final al autorizării se află la adresa:
Obțineți un simbol de acces
Exemplu de solicitare:
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
Exemplu de răspuns:
{
"access_token": "eyJh…", // access token used in authenticated API requests
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Reînnoirea tokenului
Când expiră access_tokenu, refresh_token este disponibilă.
Exemplu de solicitare:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Tipul de sistem de securitate
Schema de autorizare HTTP
HTTP
purtător
Crearea unei activități
Apelați punctul final POST /v1/tasks/BATCH și utilizați CreateCloudTaskTransactionApiRequest cu următoarele informații completate pentru a face solicitarea:
Variabil
dată
OBLIGATORIU
OBLIGATORIU
apiKey
OBLIGATORIU
OBLIGATORIU
tid
OBLIGATORIU
OBLIGATORIU
initiator
OBLIGATORIU
OBLIGATORIU
title
OBLIGATORIU
OBLIGATORIU
timp de viață
Format
string
string
string
string
string
Număr întreg
Descriere
Tranzacțiile cu o dată mai veche sau aceeași dată vor fi închise. Toate tranzacțiile până la această dată de la ultimul lot închis cu succes vor fi incluse.
API Cheia poate fi găsită în aplicație la secțiunea Account-Cloud API . Aceasta este utilizată pentru a distinge autentificările în principal în Cloud API .
TID-ul țintă pentru activitate. TID = ID terminal, care este unic pentru fiecare dispozitiv. Un singur DDIL poate fi utilizat la un moment dat pe toate dispozitivele instalate.
Descrierea inițiatorului ar trebui să fie unică pentru fiecare instanță a subsistemului care poate iniția sarcina. Exemplu: "Server XY" sau "Casierie 1"
Nume de activitate care poate fi citit de om. Acesta ar trebui să conțină o anumită identificare a sarcinii.
Exemplu: "Factură 37364FD"
Exemplu: "Factură 37364FD"
Limit pro vypršení platnosti cloudové úlohy. Je povoleno zadat hodnoty z intervalu <10 až 172800> sekund.
Exemplu
2025-12-18T08:21:39.427SA
333W212J3
483590
Casierie 12
Termen 36744
10
Conținutul răspunsului [CloudTaskDetailApiResponse]:
Codurile de răspuns posibile sunt:
Răspunde
RC200
RC403
RC406
RC 502
Mesaj
OK - Activitatea a fost înregistrată
Utilizatorul nu are voie să înregistreze sarcina pe terminalul dat
sarcina nu este acceptabilă pentru terminal
Notificare push netransmisă
Descriere
Sarcina a fost creată cu succes și va fi procesată.
Dacă detaliile de conectare API nu se potrivesc cu valoarea TID trimis (de exemplu, dacă proprietarul TID este diferit).
Acest lucru se întâmplă de obicei atunci când TID nu poate procesa solicitarea.
Notificarea push nu a fost trimisă din cauza unei defecțiuni a serviciului în amonte.
Cum să se comporte
Treceți la pasul următor din fluxul de tranzacții.
Verificați dacă ați completat TID-ul corect și încercați din nou.
Verificați mesajul de eroare.
Mai jos veți găsi variabilele utilizate în răspuns:
Variabil
title
taskId
created
taskClass
status
initiator
contextId
payload
exceptionId
tip
message
context
Format
string
string
string
string
string
string
string
object
string
string
string
string
Descriere
Nume de activitate care poate fi citit de om. Utilizat din valoarea cererii.
Id activitate internă
Data și ora la care a fost creată activitatea.
Clasa de sarcină utilăMopworthy valori: [TRANSACTION, BATCH, DUMMY]
Starea activității în cloud. Valori posibile: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
O descriere a inițiatorului de partea clientului. Utilizat din valoarea cererii.
ID-ul entității țintă afectate, dacă există (transactionId / batchId)
Corpul de activități contextuale - în funcție de taskClass
ID de excepție pseudo-unic. Acesta poate servi ca un "ID de suport" pe care utilizatorul îl poate comunica pentru a sprijini, astfel încât să poată investiga eroarea.
Tipul excepției.
Mesaj de excepție.
Contextul excepției. Află mai multe.
Exemplu
Uzaverka 123
dFd3sda
LOT
CREATED
Casierie 12
{...}
FujIk6
VALIDATION_EXCEPTION
Parolă prea slabă
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
DA
DA
DA
DA
DA
DA
DA
DA
BINE
BINE
BINE
BINE
RC403
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
DA
DA
DA
DA
RC406
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
DA
DA
DA
DA
RC502
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
DA
DA
DA
DA
Verificarea stării unei activități
V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:
Variabil
taskId
Format
string
Descriere
ID-ul activității pe care ați primit-o ca parte a pasului anterior.
Exemplu
dFd3sda
Coduri de returnare posibile:
Răspunde
RC200
RC403
Mesaj
OK - Stare activitate disponibilă
Cloud de locuri de muncă nu a fost găsit pentru terminalul curent.
Mesaj
Actualizarea stării activității a fost procesată cu succes.
Ar trebui să verificați taskID-ul și să retrimiteți valoarea corectă.
Descriere
Dacă nu primiți starea finală (vedeți mai jos), repetați acest pas.
Verificați dacă ați completat id-ul de activitate corect și încercați din nou.
Variabile în răspuns:
Variabil
title
taskId
created
taskClass
status
initiator
contextID
payload
exceptionId
tip
message
context
Format
string
string
string
string
string
string
string
string
string
string
string
Descriere
Nume de activitate care poate fi citit de om. Utilizat din valoarea solicitării de creare a activității.
ID-ul activității interne
Data și ora la care a fost creată activitatea.
Valori posibile: [TRANZACȚIE, LOT, MANECHIN]
Valori posibile: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
O descriere a inițiatorului de partea clientului. Utilizat din valoarea cererii.
ID-ul entității țintă afectate, dacă există (transactionId / batchId)
ID de excepție pseudo-unic. Acesta poate servi ca un "ID de suport" pe care utilizatorul îl poate comunica pentru a sprijini, astfel încât să poată investiga orice problemă.
Tipul excepției.
Mesaj de excepție.
Contextul excepției - mai multe informații.
Exemplu
Factură 36744
dFd3sda
2025-12-18T08:21:39.427SA
LOT
IN_PROGRESS
Casierie 12
12DFSFSSF
FujIk6
VALIDATION_EXCEPTION
Parolă prea slabă
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
DA
DA
DA
DA
DA
DA
DA
DA
BINE
BINE
BINE
BINE
RC404
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
DA
DA
DA
DA
Solicitarea de stare a activității trebuie repetată până când obțineți unul dintre codurile de răspuns finale, care sunt:
Stare
INIT_ERROR
COMPLETED
CANCELLED
ERROR
Descriere
Procesul de plată nu a reușit să inițializeze. Verificați dacă eroarea pe care ați primit-o.
După ce obțineți această stare, activitatea a fost finalizată și rezultatul este disponibil.
Activitatea a fost anulată de utilizator.
A apărut o eroare în timpul procesării lucrării.
Cum să se comporte
Urmați instrucțiunile de eroare.
Puteți trece la pasul următor.
Ar trebui să începeți o nouă activitate, deoarece această activitate a fost anulată de utilizator.
Urmați instrucțiunile de eroare.
Puteți trece la pasul următor numai atunci când răspunsul este în starea finalizată.
Obținerea rezultatului de închidere
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é:
Variabil
batchId
Format
string
Descriere
ID-ul lotului pe care îl obțineți în pașii anteriori.
Exemplu
12DFSFSSF
Codurile de răspuns posibile sunt:
Răspunde
RC200
RC404
Mesaj
OK – detalii de închidere furnizate
Nu a fost găsit un termen limită pentru actualul TID.
Mesaj
Răspuns reușit la solicitarea privind termenul limită.
Această condiție apare atunci când nu a fost găsit un ID de dată de închidere dat pentru dispozitivul dvs.
Descriere
Tranzacția este finalizată!
Verificați ID-ul tranzacției.
Răspunsul conține următoarele variabile, în funcție de codul de răspuns:
Variabil
batchid
communicationId
batchNumber
date
previousBatchDate
firstTransactionDate
totalAmount
currency
totalCount
saleCount
saleAmount
voidCount
voidAmount
invalidcount
amsBatchNumber
subBatches
Format
string
string
string
string
string
string
număr
string
număr
număr
număr
număr
număr
număr
string
object
Descriere
ID-ul batch-ului intern, OPEN pentru pseudo batch cu tranzacții deschise.
Poate fi folosit pentru suport tehnic. Pseudo ID unic în scopuri de logare.
Numărul lotului pentru TID.
Data și ora exactă la care lotul a fost închis.
Data și ora începerii dozei închise. Aveți o perioadă de timp pentru acest lot (OD: previousBatchDate TO: data valorii).
Data celei mai vechi tranzacții.
Suma totală pentru toate tipurile de tranzacții.
Moneda de închidere
Numărul total de tranzacții în lot
Numărul de tranzacții de vânzare din lot.
Volumul tranzacțiilor de vânzare în lot.
Numărul tuturor tranzacțiilor de anulare din lot.
Volumul tuturor tranzacțiilor de anulare din lot.
Numărul de tranzacții nevalide în lot
ID-ul batch-ului intern, OPEN pentru pseudo batch cu tranzacții deschise.
Loturi de bază într-un meta lot – o defalcare pe tip de tranzacție și include informații statistice despre loturile subordonate în funcție de tipul de metodă de plată. Conţine:
-closeBatchNumber (șir) - closeBatchNumber grup copil
- totalCount (număr) - Numărul total de tranzacții în lot
- saleCount (număr) - Numărul de tranzacții de tip vânzări în lot
- saleAmount (număr) - Volumul tranzacțiilor de tip vânzări în lot
- voidCount (număr) - Numărul de anulări ale tranzacțiilor
- voidAmount (număr) - volumul anulării tranzacției în lot
-closeBatchNumber (șir) - closeBatchNumber grup copil
- totalCount (număr) - Numărul total de tranzacții în lot
- saleCount (număr) - Numărul de tranzacții de tip vânzări în lot
- saleAmount (număr) - Volumul tranzacțiilor de tip vânzări în lot
- voidCount (număr) - Numărul de anulări ale tranzacțiilor
- voidAmount (număr) - volumul anulării tranzacției în lot
Exemplu
12DFSFSSF
2
2025-12-18T08:21:39.427SA
2025-12-17T12:22:11.427SA