Informație
Cloud API Dacă apelați o anulare prin , trebuie să creați o sarcină pentru dispozitivul (TID) pe care a fost efectuată inițial plata. Apelarea unei anulări efectuate pe terminalul "A" pe terminalul "B" nu este acceptată în prezent.
Inversarea tranzacției este o operațiune de plată de bază care vă permite să anulați o tranzacție procesată anterior până la 93 de zile după tranzacția inițială. Anularea tranzacției se poate face fără un card de client – fondurile vor fi returnate automat pe cardul utilizat pentru tranzacția inițială de tip vânzare.
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/TRANSACTION și utilizați CreateCloudTaskTransactionApiRequest cu următoarele informații completate pentru a face solicitarea:
Variabil
apiKey
OBLIGATORIU
OBLIGATORIU
tid
OBLIGATORIU
OBLIGATORIU
initiator
OBLIGATORIU
OBLIGATORIU
title
OBLIGATORIU
OBLIGATORIU
printByPaymentApp
amount
OBLIGATORIU
OBLIGATORIU
tipAmount
transactionOperation
originTransactionId
originReferenceNum
cancelMode
OBLIGATORIU
OBLIGATORIU
transactionType*
OBLIGATORIU
OBLIGATORIU
currencyCode
timp de viață
Format
string
string
string
string
Boolean
număr
număr
string
string
string
string
string
string
Număr întreg
Descriere
API cheie poate fi găsită direct în aplicație, în secțiunea Cont-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 plată"
Exemplu: "Factură 37364FD plată"
implicit: adevărat
Adevărat dacă chitanța urmează să fie imprimată pe dispozitiv.
Notă: Pentru telefoanele mobile, asigurați-vă că imprimanta Bluetooth este conectată.
Adevărat dacă chitanța urmează să fie imprimată pe dispozitiv.
Notă: Pentru telefoanele mobile, asigurați-vă că imprimanta Bluetooth este conectată.
Valoarea tranzacției care urmează să fie anulată trebuie să fie non-zero și să includă zecimale.
Nu este folosit pentru anulare.
Tipul de tranzacție de activitate. Pentru tranzacția "Anularea tranzacției", completați valoarea "VOID".
ID-ul tranzacției de anulat. Nu este nul dacă modul VOID și anula sunt OLDER_TRANSACTION.
Dacă nu doriți să imprimați această valoare pe chitanță, lăsați-o necompletată.
Valori posibile: [ LAST_TRANSACTION, OLDER_TRANSACTION ] în cazul în care:
LAST_TRANSACTION - utilizat numai pentru o tranzacție autorizată anterior. Nu poate exista nicio altă cerință între această activitate și activitatea de vânzări anterioară.
OLDER_TRANSACTION – Utilizat pentru toate tranzacțiile mai vechi, cu excepția ultimei tranzacții.
LAST_TRANSACTION - utilizat numai pentru o tranzacție autorizată anterior. Nu poate exista nicio altă cerință între această activitate și activitatea de vânzări anterioară.
OLDER_TRANSACTION – Utilizat pentru toate tranzacțiile mai vechi, cu excepția ultimei tranzacții.
Valori posibile: [ CASH, CARD, GO_CRYPTO ]
3 caractere pentru codul monedei (ISO 4217)
Limita de expirare pentru activitatea în cloud. Este permisă specificarea valorilor din intervalul de secunde.
Exemplu
333W212J3
483590
Casierie 12
Anularea 36744
fals
40000
NEFOLOSIT
NUL
FD2837373333
FACULTATIV
OLDER_TRANSACTION
CARD
CZK
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
Factură 36744
dFd3sda
TRANZACȚIE
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
IN_PROGRESS
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
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 unui rezultat de plată
Nyní víme, že transakce byla autorizována. Cílem tohoto kroku je získat stav transakce a detaily transakce. Pro nový požadavek zavoláte koncový bod GET /v1/transactions/{transactionId}, kde použijete následující proměnné:
Variabil
transactionId
Format
string
Descriere
ID-ul tranzacției pe care îl obțineți în pașii anteriori.
Exemplu
4414c640-2db7-11ec-910a-91880dadec20
Codurile de răspuns posibile sunt:
Răspunde
RC200
RC404
Mesaj
OK – detaliile tranzacției furnizate
O tranzacție nu a putut fi găsită pentru TID curent.
Mesaj
Răspuns cu succes la solicitarea dvs.
Această condiție apare atunci când un anumit ID de tranzacție nu a fost găsit 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
result
responseMessage
transanctionId
transactionOperation
transactionType
merchantID
tid
currencyCode
amount
tipAmount
cardNumber
cardDataEntry
referenceNumber
invoiceNumber
date
emvAppLabel
sequenceNumber
exceptionId
tip
message
context
Format
string
string
string
string
string
string
string
string
număr
număr
string
string
string
string
string
string
string
string
string
string
string
Descriere
Rezultatul tranzacției, valori posibile [ ACCEPTED, DECLINED, CANCELLED ] în cazul în care:
ACCEPTED - tranzacția a fost autorizată cu succes
DECLINED - tranzacția a fost respinsă din anumite motive
CANCELLED - în cazul în care tranzacția este anulată de către operator sau client
ACCEPTED - tranzacția a fost autorizată cu succes
DECLINED - tranzacția a fost respinsă din anumite motive
CANCELLED - în cazul în care tranzacția este anulată de către operator sau client
O descriere mai detaliată a valorii rezultate.
ID-ul de activitate intern
Tarife posibile: ""SALE"" "VOID"" "REFUND""
Tipul operațiunii/tranzacției."
Tipul operațiunii/tranzacției."
Valori posibile: "CASH" "CARD" "GO_CRYPTO"
Numai pentru tranzacțiile cu cardul - ID-ul sucursalei.
ID-ul tranzacției creat de terminal
Codul monedei (ISO 4217)
Valoarea tranzacției cu 2 zecimale (400 CZK).
Valoarea bacșișului introdus la 2 zecimale (30 CZK).
Numărul cardului mascat.
Metoda de încărcare a cardului - mag.strip, cip sau contactless.
Numărul de referință al tranzacției preluat din valoarea de activitate a solicitării: originReferenceNum
Data și ora autorizării tranzacției
Card de marcă EMV preluat din datele cardului
Numărul generat pe partea gp
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.
Tip de excepție
Mesaj de excepție
Contextul excepției - mai multe informații.
Exemplu
ACCEPTATE
Zero
4414c640-2db7-11ec-910a-91880dadec20
NUL
CARD
343382001
483591
40000
-
1233
Zero
FD123456
2020-09-16T09:31:16.000S
Zero
102304128
FujIk6
VALIDATION_EXCEPTION
Parolă prea slabă
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC 200
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
DA
BINE
BINE
BINE
BINE
RC 404
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
BINE
DA
DA
DA
DA
Dacă aveți de gând să generați sau să imprimați chitanța de partea dvs., vă recomandăm să verificați ce câmpuri sunt necesare și trebuie să fie imprimate / afișate pe chitanță. Descrierea este disponibilă aici.