0 Kč
Prihlásenie / Registrácia
KÚPIŤ
Zobraziť kategórie

Zrušenie transakcie

Informácia

Ak cez Cloud API keď zavoláte na zrušenie platby, je potrebné vytvoriť úlohu pre zariadenie (TID), kde bola platba pôvodne vykonaná. Volanie na zrušenie platby uskutočnenej na termináli "A" na termináli "B" nie je v súčasnosti podporované.

Vrátenie transakcie je základná platobná operácia, ktorá vám umožňuje zrušiť predtým spracovanú transakciu do 93 dní po pôvodnej transakcii. Zrušenie transakcie je možné vykonať bez zákazníckej karty – prostriedky budú automaticky vrátené na kartu použitú na pôvodnú transakciu typu predaja.

Prihlásenie & autentifikácia

Overenie tokenom JWT sa vyžaduje pre všetky neverejné koncové body. Token (so životnosťou 90 dní) získate prostredníctvom koncového bodu /cloud/oauth/token s nasledujúcimi argumentmi:

Získanie prístupového tokenu

Príklad žiadosti:

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

Príklad odpovede:

{
"access_token": "eyJh…", // access token used in authenticated API requests
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}

Obnovenie tokenu

Po uplynutí platnosti access_tokenu je k dispozícii refresh_token.

Príklad žiadosti:

POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token&refresh_token=GciO…

GPTomAuth

Druh systému zabezpečenia
Schéma autorizácie HTTP
SK
Nosič

Vytvorenie úlohy

Zavolajte na koncový bod POST /v1/úlohy/TRANSACTION a na podanie žiadosti použite CreateCloudTaskTransactionApiRequest s vyplnenými nasledujúcimi informáciami:

Premenná
apiKey
MANDATORY
tid
POVINNÝ
initiator
POVINNÝ
title
POVINNÝ
printByPaymentApp
amount
POVINNÝ
tipAmount
transactionOperation
originTransactionId
originReferenceNum
cancelMode
POVINNÝ
transactionType*
POVINNÝ
currencyCode
Čas na život
Formát
string
string
string
string
Boolean
number
number
string
string
string
string
string
string
celé číslo
Popis: __________
API kľúč nájdete priamo v aplikácii v časti Účet -Cloud API . Používa sa na rozlíšenie prihlasovacích údajov najmä na stránke Cloud API .
Cieľový TID pre danú úlohu. TID = ID terminálu, ktoré je jedinečné pre každé zariadenie. Na všetkých nainštalovaných zariadeniach je možné naraz použiť iba jeden TID.
Opis iniciátora by mal byť jedinečný pre každú inštanciu subsystému, ktorá môže iniciovať úlohu. Príklad: "Server XY" alebo "Pokladník 1"
Názov úlohy čitateľný ľudským okom. Mal by obsahovať určitú identifikáciu úlohy.
Príklad: "Platba faktúry 37364FD"
predvolené: true
Platí, ak sa má účtenka vytlačiť na zariadení.
Poznámka: V prípade mobilných telefónov skontrolujte, či je pripojená tlačiareň Bluetooth.
Suma transakcie, ktorá sa má zrušiť, musí byť nenulová a musí obsahovať desatinné miesta.
Nepoužíva sa na zrušenie.
Typ transakcie úlohy. V prípade transakcie "Zrušenie transakcie" vyplňte hodnotu "VOID".
ID transakcie na zrušenie. Nie je neplatné, ak je režim VOID a zrušenie OLDER_TRANSACTION.
Ak nechcete vytlačiť túto hodnotu na účtenke, nechajte ju prázdnu.
Možné hodnoty: [ LAST_TRANSACTION, OLDER_TRANSACTION ], kde:
LAST_TRANSACTION - používa sa iba na predtým autorizovanú transakciu. Medzi touto úlohou a predchádzajúcou predajnou úlohou nemôže byť žiadna iná požiadavka.
OLDER_TRANSACTION – Používa sa pre všetky staršie transakcie okrem poslednej transakcie.
Možné hodnoty: [ CASH, CARD ]
3 znaky pre kód meny (ISO 4217)
Limit pre uplynutie platnosti cloudovej úlohy. Hodnoty z druhého intervalu je možné špecifikovať.
Príklad
333W212J3
483590
Pokladňa 12
Zrušenie 36744
nepravdivé
40000
NEPOUŽÍVA SA
VÁKUUM
FD283737333
VOLITEĽNÝ
OLDER_TRANSACTION
KARTA
KČ
10

Obsah odpovede [CloudTaskDetailApiResponse]:

Možné kódy odpovedí sú:

Odpoveď
RC200
RC403
RC406
RC 502
Správa
OK - Úloha bola zaregistrovaná
Používateľ nie je oprávnený zaregistrovať úlohu na danom termináli
úloha nie je prijateľná pre terminál
Push notifikácia nie je odoslaná
Popis: __________
Úloha bola úspešne vytvorená a bude spracovaná.
Ak sú vaše prihlasovacie údaje API sa nezhodujú s odoslanou hodnotou TID (napríklad ak je vlastník TID iný).
To sa zvyčajne stáva, keď TID nie je schopný spracovať žiadosť.
Push notifikácia nebola odoslaná z dôvodu zlyhania služby na dodávateľskom trhu.
Ako sa správať
Prejdite na ďalší krok v toku transakcií.
Skontrolujte, či ste vyplnili správny TID, a skúste to znova.
Skontrolujte chybové hlásenie.

Nižšie nájdete premenné použité v odpovedi:

Premenná
title
taskId
created
taskClass
status
initiator
contextId
Payload
exceptionId
typ
message
context
Formát
string
string
string
string
string
string
string
object
string
string
string
string
Popis: __________
Názov úlohy čitateľný ľudským okom. Použité z hodnoty požiadavky.
Interné id úlohy
Dátum a čas vytvorenia úlohy.
Trieda užitočného zaťaženiaMonopworthné hodnoty: [TRANSAKCIA, DÁVKA, FIGURÍNA]
Stav cloudovej úlohy. Možné hodnoty: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Popis iniciátora na strane klienta. Použité z hodnoty požiadavky.
ID dotknutej cieľovej entity, ak existuje (transactionId / batchId)
Kontextové telo úlohy – v závislosti od úlohyClass
Pseudo-jedinečné ID výnimky. Môže slúžiť ako "ID podpory", ktoré môže používateľ komunikovať s podporou, aby mohol chybu vyšetriť.
Druh výnimky.
Správa o výnimke.
Kontext výnimky. Zistiť viac.
Príklad
Faktúra 36744
dFd3sda
TRANSAKCIA
CREATED
Pokladňa 12
{...}
FujIk6
VALIDATION_EXCEPTION
Príliš slabé heslo
[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

Kontrola stavu úlohy

V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:

Premenná
taskId
Formát
string
Popis: __________
Identifikácia úlohy, ktorú ste dostali v rámci predchádzajúceho kroku.
Príklad
dFd3sda

Možné návratové kódy:

Odpoveď
RC200
RC403
Správa
OK – stav úlohy je k dispozícii
Cloudová úloha sa pre aktuálny terminál nenašla.
Správa
Aktualizácia stavu zákazky bola úspešne spracovaná.
Mali by ste skontrolovať ID úlohy a znova odoslať správnu hodnotu.
Popis: __________
Ak nedostanete konečný stav (pozri nižšie), zopakujte tento krok.
Skontrolujte, či ste vyplnili správne ID úlohy, a skúste to znova.

Premenné v odpovedi:

Premenná
title
taskId
created
taskClass
status
initiator
contextID
Payload
exceptionId
typ
message
context
Formát
string
string
string
string
string
string
string
string
string
string
string
Popis: __________
Názov úlohy čitateľný ľudským okom. Používa sa z hodnoty žiadosti o vytvorenie úlohy.
Interná identifikácia úlohy
Dátum a čas vytvorenia úlohy.
Možné hodnoty: [TRANSAKCIA, DÁVKA, FIGURÍNA]
Možné hodnoty: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Popis iniciátora na strane klienta. Použité z hodnoty požiadavky.
ID dotknutej cieľovej entity, ak existuje (transactionId / batchId)
Pseudo-jedinečné ID výnimky. Môže slúžiť ako "ID podpory", ktoré môže používateľ komunikovať s podporou, aby mohol vyšetriť akýkoľvek problém.
Druh výnimky.
Správa o výnimke.
Kontext výnimky - viac informácií.
Príklad
Faktúra 36744
dFd3sda
IN_PROGRESS
Pokladňa 12
FujIk6
VALIDATION_EXCEPTION
Príliš slabé heslo
[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

Žiadosť o stav úlohy by sa mala opakovať, kým nedostanete jeden z kódov konečnej odpovede, ktoré sú:

Stav
INIT_ERROR
COMPLETED
CANCELLED
ERROR
Popis: __________
Platobný proces sa nepodarilo inicializovať. Skontrolujte chybu, ktorá sa vám zobrazila.
Po získaní tohto stavu bola úloha dokončená a výsledok je k dispozícii.
Úloha bola používateľom zrušená.
Pri spracovaní zákazky sa vyskytla chyba.
Ako sa správať
Postupujte podľa pokynov na chybu.
Môžete prejsť na ďalší krok.
Mali by ste začať novú prácu, pretože túto úlohu používateľ zrušil.
Postupujte podľa pokynov na chybu.

K ďalšiemu kroku môžete pristúpiť len vtedy, keď je odpoveď v stave DOKONČENÉ.

Získanie výsledku platby

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é:

Premenná
transactionId
Formát
string
Popis: __________
ID transakcie, ktoré získate v predchádzajúcich krokoch.
Príklad
4414c640-2db7-11ec-910a-91880dadec20

Možné kódy odpovedí sú:

Odpoveď
RC200
RC404
Správa
OK – poskytnuté údaje o transakcii
Transakciu sa nepodarilo nájsť pre aktuálny TID.
Správa
Úspešná odpoveď na vašu žiadosť.
Táto podmienka sa vyskytuje, keď sa pre vaše zariadenie nenašiel daný identifikátor transakcie.
Popis: __________
Transakcia je dokončená!
Skontrolujte ID transakcie.

Odpoveď obsahuje nasledujúce premenné v závislosti od kódu odpovede:

Premenná
result
responseMessage
transanctionId
transactionOperation
transactionType
merchantID
tid
currencyCode
amount
tipAmount
cardNumber
cardDataEntry
referenceNumber
invoiceNumber
date
emvAppLabel
sequenceNumber
exceptionId
typ
message
context
Formát
string
string
string
string
string
string
string
string
number
number
string
string
string
string
string
string
string
string
string
string
string
Popis: __________
Výsledok transakcie, možné hodnoty [ ACCEPTED, DECLINED, CANCELLED ], kde:
ACCEPTED - transakcia bola úspešne autorizovaná
DECLINED - transakcia bola z nejakého dôvodu zamietnutá
CANCELLED - ak je transakcia zrušená prevádzkovateľom alebo zákazníkom
Podrobnejší opis výslednej hodnoty.
Interné ID úlohy
Možné sadzby: ""SALE"" "VOID"" "REFUND""
Typ operácie/transakcie."
Možné hodnoty "CASH" "CARD"
Iba pre kartové transakcie - ID pobočky.
ID transakcie vytvorené terminálom
Kód meny (ISO 4217)
Suma transakcie s 2 desatinnými miestami (400 Kč).
Suma prepitného zadaná na 2 desatinné miesta (30 Kč).
Číslo maskovanej karty.
Spôsob načítania karty - mag.strip, čip alebo bezkontaktný.
Referenčné číslo transakcie prevzaté z hodnoty úlohy v žiadosti: originReferenceNum
Dátum a čas autorizácie transakcie
Karta značky EMV prevzatá z údajov o karte
Číslo vygenerované na strane GP
Pseudo-jedinečné ID výnimky. Môže slúžiť ako "ID podpory", ktoré môže používateľ komunikovať s podporou, aby mohol preskúmať.
Typ výnimky
Správa o výnimke
Kontext výnimky - viac informácií.
Príklad
AKCEPTOVANÝ
Nula
4414c640-2db7-11ec-910a-91880dadec20
VÁKUUM
KARTA
343382001
483591
40000
-
1233
Nula
FD123456
2020-09-16T09:31:16.000S
Nula
102304128
FujIk6
VALIDATION_EXCEPTION
Príliš slabé heslo
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC 200
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
NO
NO
NO
NO
RC 404
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
YES
YES
YES
YES

Ak sa chystáte vygenerovať alebo vytlačiť účtenku na svojej strane, odporúčame vám skontrolovať, ktoré polia sú povinné a musia byť vytlačené/zobrazené na účtenke. Popis je k dispozícii tu.

Ako sa vám páči tento tutoriál?