Πληροφορίες
Εάν πραγματοποιήσετε μια κλήση ακύρωσης μέσω του Cloud API, πρέπει να δημιουργήσετε μια εργασία για τη συσκευή (TID) στην οποία έγινε αρχικά η πληρωμή. Η κλήση μιας αντιστροφής πληρωμής που πραγματοποιήθηκε στο τερματικό "A" στο τερματικό "B" δεν υποστηρίζεται επί του παρόντος.
Η συναλλαγή ακύρωσης είναι μια βασική πράξη πληρωμής που σας επιτρέπει να ακυρώσετε μια προηγουμένως επεξεργασμένη συναλλαγή έως και 93 ημέρες από την αρχική συναλλαγή. Η ακύρωση μιας συναλλαγής μπορεί να γίνει χωρίς κάρτα πελάτη - τα χρήματα θα επιστραφούν αυτόματα στην κάρτα που χρησιμοποιήθηκε για την αρχική συναλλαγή πώλησης.
Σύνδεση & πιστοποίηση ταυτότητας
Για όλα τα μη δημόσια τελικά σημεία απαιτείται έλεγχος ταυτότητας με token JWT. Το token (με διάρκεια ζωής 90 ημερών) λαμβάνεται μέσω του τελικού σημείου /cloud/oauth/token με τα ακόλουθα ορίσματα:
- Βασικός έλεγχος ταυτότητας για τερματικά σημεία token (όνομα/συνθηματικό) - θα παρέχεται για κάθε χρήστη.
- Όνομα χρήστη εμπόρου - το ίδιο όπως για το GP tom
- Κωδικός πρόσβασης εμπόρου - ο ίδιος όπως για το GP tom
- Terminal ID (TID) - ID του τερματικού σταθμού προορισμού
- Το τελικό σημείο εξουσιοδότησης βρίσκεται στη διεύθυνση:
Λήψη ενός κουπονιού πρόσβασης
Παράδειγμα αίτησης:
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
Παράδειγμα απάντησης:
{
"access_token": "eyJh…", // access token used in authenticated API requests
"token_type": "bearer",
"refresh_token": "GciO…",
"expires_in": 3600,
"scope": "read write",
"tid": "999888",
}Ανανέωση ενός κουπονιού
Όταν το access_token λήξει, είναι διαθέσιμο ένα refresh_token.
Παράδειγμα αίτησης:
POST {{apiHost}}/api/oauth/token
Authorization: Basic YXRvbTphc2hmdWY0ZTVmYQ==
Content-Type: application/x-www-form-urlencoded
grant_type=refresh_token&refresh_token=GciO…
GPTomAuth
Τύπος συστήματος ασφαλείας
Σχήμα εξουσιοδότησης HTTP
HTTP
κομιστής
Δημιουργία τσάντας
Καλέστε το τελικό σημείο POST /v1/tasks/TRANSACTION και χρησιμοποιήστε το CreateCloudTaskTransactionApiRequest με τις ακόλουθες πληροφορίες συμπληρωμένες για να δημιουργήσετε την αίτηση:
Μεταβλητή
apiKey ΥΠΟΧΡΕΩΤΙΚΟ
tid ΕΝΤΟΛΕΣ
εκκινητής ΥΠΟΧΡΕΩΣΕΙΣ
τίτλος ΥΠΟΧΡΕΩΤΙΚΟ
printByPaymentApp
ποσό ΥΠΟΧΡΕΩΤΙΚΟ
TipAmount
transactionOperation
originTransactionId
originReferenceNum
cancelMode ΥΠΟΧΡΕΩΤΙΚΟ
transactionType* ΥΠΟΧΡΕΩΤΙΚΟ
currencyCode
timeToLive
Μορφή
string
string
string
string
boolean
αριθμός
αριθμός
string
string
string
string
string
string
Ακέραιος αριθμός
Περιγραφή
Το κλειδί API βρίσκεται απευθείας στην εφαρμογή στην ενότητα Account-Cloud API. Χρησιμοποιείται για τη διάκριση των συνδέσεων κυρίως στο Cloud API.
Το TID στόχου για την εργασία. TID = αναγνωριστικό τερματικού, το οποίο είναι μοναδικό για κάθε συσκευή. Μόνο ένα TID μπορεί να χρησιμοποιηθεί κάθε φορά σε όλες τις εγκατεστημένες συσκευές.
Η περιγραφή του εκκινητή πρέπει να είναι μοναδική για κάθε περίπτωση υποσυστήματος που μπορεί να εκκινήσει μια εργασία. Παράδειγμα: "Server XY" ή "Checkout 1".
Ένας τίτλος εργασίας με δυνατότητα ανάγνωσης από τον άνθρωπο.
Θα πρέπει να περιλαμβάνει κάποια στοιχεία αναγνώρισης της εργασίας. Παράδειγμα: "Τιμολόγιο 37364FD πληρωμή".
Θα πρέπει να περιλαμβάνει κάποια στοιχεία αναγνώρισης της εργασίας. Παράδειγμα: "Τιμολόγιο 37364FD πληρωμή".
default: true Αληθές αν η απόδειξη πρέπει να εκτυπωθεί στη συσκευή. Σημείωση: Για κινητά τηλέφωνα, βεβαιωθείτε ότι ο εκτυπωτής Bluetooth είναι συνδεδεμένος.
Το ποσό της προς ακύρωση συναλλαγής πρέπει να είναι μη μηδενικό και να περιλαμβάνει δεκαδικά ψηφία.
Δεν χρησιμοποιείται για ακύρωση.
Τύπος συναλλαγής της τσάντας. Για τη συναλλαγή "Συναλλαγή ακύρωσης", συμπληρώστε την τιμή "VOID".
Αναγνωριστικό συναλλαγής για ακύρωση. Δεν είναι null εάν η λειτουργία είναι VOID και η ακύρωση είναι OLDER_TRANSACTION.
Εάν δεν θέλετε να εκτυπώσετε αυτή την τιμή στην απόδειξη, αφήστε την κενή.
Πιθανές τιμές: [ LAST_TRANSACTION, OLDER_TRANSACTION ] όπου: LAST_TRANSACTION - χρησιμοποιείται μόνο για μια προηγουμένως εξουσιοδοτημένη συναλλαγή.
Δεν μπορεί να υπάρξει άλλη αίτηση μεταξύ αυτής της εργασίας και της προηγούμενης εργασίας πωλήσεων. OLDER_TRANSACTION - χρησιμοποιείται για όλες τις παλαιότερες συναλλαγές εκτός από την τελευταία συναλλαγή.
Πιθανές τιμές: [ CASH, CARD, GO_CRYPTO ]
3 χαρακτήρες για τον κωδικό νομίσματος (ISO 4217)
Limit pro vypršení platnosti cloudové úlohy. Je povoleno zadat hodnoty z intervalu <10 až 172800> sekund.
Παράδειγμα
333W212J3
483590
Ταμείο 12
Ακύρωση 36744
false
40000
ΔΕΝ ΧΡΗΣΙΜΟΠΟΙΕΙΤΑΙ
VOID
FD283737333
ΠΡΟΑΙΡΕΤΙΚΟ
OLDER_TRANSACTION
ΚΑΡΤΑ
CZK
10
Περιεχόμενο της [CloudTaskDetailApiResponse]:
Οι πιθανοί κωδικοί απαντήσεων είναι:
Απάντηση
RC200
RC403
RC406
RC 502
Αναφορά
OK - Η εργασία έχει καταχωρηθεί
Ο χρήστης δεν επιτρέπεται να καταχωρήσει μια εργασία στο τερματικό
Η εργασία δεν είναι αποδεκτή για το τερματικό
Η ειδοποίηση Push δεν αποστέλλεται
Περιγραφή
Η εργασία δημιουργήθηκε με επιτυχία και θα υποβληθεί σε επεξεργασία.
Εάν τα διαπιστευτήρια API δεν ταιριάζουν με την τιμή TID που στείλατε (για παράδειγμα, εάν ο ιδιοκτήτης του TID είναι διαφορετικός).
Αυτό συμβαίνει συνήθως όταν το TID δεν είναι σε θέση να επεξεργαστεί την αίτηση.
Η ειδοποίηση Push δεν στάλθηκε λόγω αποτυχίας της υπηρεσίας upstream.
Πώς να συμπεριφέρεστε
Συνεχίστε με το επόμενο βήμα στη ροή της συναλλαγής.
Ελέγξτε ότι έχετε συμπληρώσει το σωστό TID και δοκιμάστε ξανά.
Ελέγξτε το μήνυμα σφάλματος.
Ακολουθούν οι μεταβλητές που χρησιμοποιήθηκαν στην απάντηση:
Μεταβλητή
τίτλος
taskId
δημιουργήθηκε
taskClass
κατάσταση
εκκινητής
contextId
ωφέλιμο φορτίο
exceptionId
τύπος
μήνυμα
πλαίσιο
Μορφή
string
string
string
string
string
string
string
αντικείμενο
string
string
string
string
Περιγραφή
Το ευανάγνωστο από τον άνθρωπο όνομα της τσάντας. Χρησιμοποιείται από την τιμή της αίτησης.
Εσωτερικό αναγνωριστικό της τσάντας
Η ημερομηνία και η ώρα που δημιουργήθηκε η τσάντα.
Πιθανές τιμές: [TRANSACTION, BATCH, DUMMY]
Κατάσταση σακούλας σύννεφου. Πιθανές τιμές: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Περιγραφή του εκκινητή από την πλευρά του πελάτη. Χρησιμοποιείται από την τιμή της αίτησης.
ID της επηρεαζόμενης οντότητας-στόχου, εάν υπάρχει (transactionId / batchId)
Σώμα εργασίας πλαισίου - ανάλογα με την taskClass
Ψευδο-μοναδικό αναγνωριστικό εξαίρεσης. Μπορεί να χρησιμεύσει ως "αναγνωριστικό υποστήριξης" που ο χρήστης μπορεί να πει στην υποστήριξη να διερευνήσει το σφάλμα.
Τύπος εξαίρεσης.
Έκθεση απαλλαγής.
Το πλαίσιο της εξαίρεσης. Περαιτέρω πληροφορίες.
Παράδειγμα
Τιμολόγιο 36744
dFd3sda
ΣΥΝΑΛΛΑΓΗ
ΔΗΜΙΟΥΡΓΗΜΕΝΟ
Ταμείο 12
{...}
FujIk6
VALIDATION_EXCEPTION
Πολύ αδύναμος κωδικός πρόσβασης
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
RC403
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
RC406
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
RC502
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
Ελέγξτε την κατάσταση της τσάντας
V dalším kroku budete kontrolovat stav tasku na koncovém bodu GET /v1/tasks/{taskID} pomocí požadavku, který zahrnuje:
Μεταβλητή
taskId
Μορφή
string
Περιγραφή
Το αναγνωριστικό της τσάντας που λάβατε στο προηγούμενο βήμα.
Παράδειγμα
dFd3sda
Πιθανοί κωδικοί επιστροφής:
Απάντηση
RC200
RC403
Αναφορά
OK - Διαθέσιμη κατάσταση σακούλας
Δεν βρέθηκε εργασία cloud για το τρέχον τερματικό.
Αναφορά
Η ενημέρωση της κατάστασης της εργασίας επεξεργάστηκε με επιτυχία.
Θα πρέπει να ελέγξετε το taskID σας και να υποβάλετε εκ νέου τη σωστή τιμή.
Περιγραφή
Εάν δεν λάβετε την τελική κατάσταση (βλ. παρακάτω), επαναλάβετε αυτό το βήμα.
Ελέγξτε ότι έχετε συμπληρώσει το σωστό taskID και δοκιμάστε ξανά.
Μεταβλητές απόκρισης:
Μεταβλητή
τίτλος
taskId
δημιουργήθηκε
taskClass
κατάσταση
εκκινητής
contextID
ωφέλιμο φορτίο
exceptionId
τύπος
μήνυμα
πλαίσιο
Μορφή
string
string
string
string
string
string
string
string
string
string
string
Περιγραφή
Ένας τίτλος εργασίας με δυνατότητα ανάγνωσης από τον άνθρωπο. Χρησιμοποιείται από την τιμή του αιτήματος δημιουργίας της εργασίας.
Εσωτερική ταυτότητα τσάντας
Η ημερομηνία και η ώρα που δημιουργήθηκε η τσάντα.
Πιθανές τιμές: [TRANSACTION, BATCH, DUMMY]
Πιθανές τιμές: [CREATED, STARTED, INIT_OK, INIT_ERROR, IN_PROGRESS, COMPLETED, CANCELLED, ERROR]
Περιγραφή του εκκινητή από την πλευρά του πελάτη. Χρησιμοποιείται από την τιμή της αίτησης.
ID της επηρεαζόμενης οντότητας-στόχου, εάν υπάρχει (transactionId / batchId)
Ψευδο-μοναδικό αναγνωριστικό εξαίρεσης. Μπορεί να χρησιμεύσει ως "αναγνωριστικό υποστήριξης" που ο χρήστης μπορεί να αναφέρει στην υποστήριξη για να διερευνήσει ένα πιθανό πρόβλημα.
Τύπος εξαίρεσης.
Έκθεση εξαιρέσεων.
Πλαίσιο απαλλαγής - περαιτέρω πληροφορίες.
Παράδειγμα
Τιμολόγιο 36744
dFd3sda
IN_PROGRESS
Ταμείο 12
FujIk6
VALIDATION_EXCEPTION
Πολύ αδύναμος κωδικός πρόσβασης
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC200
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
RC404
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
Το αίτημα για την κατάσταση του σάκου θα πρέπει να επαναλαμβάνεται μέχρι να λάβετε έναν από τους τελικούς κωδικούς απάντησης, οι οποίοι είναι:
Κατάσταση
INIT_ERROR
ΟΛΟΚΛΗΡΩΜΕΝΟ
ΑΚΥΡΩΘΗΚΕ
ΣΦΑΛΜΑ
Περιγραφή
Η έναρξη της διαδικασίας πληρωμής απέτυχε. Ελέγξτε το σφάλμα που λάβατε.
Μόλις λάβετε αυτή την κατάσταση, η εργασία σας έχει ολοκληρωθεί και το αποτέλεσμα είναι διαθέσιμο.
Η εργασία ακυρώθηκε από τον χρήστη.
Προέκυψε σφάλμα κατά την επεξεργασία της εργασίας.
Πώς να συμπεριφέρεστε
Ακολουθήστε τις οδηγίες για το σφάλμα.
Μπορείτε να συνεχίσετε με το επόμενο βήμα.
Θα πρέπει να ξεκινήσετε μια νέα εργασία επειδή αυτή η εργασία έχει ακυρωθεί από τον χρήστη.
Ακολουθήστε τις οδηγίες για το σφάλμα.
Μπορείτε να προχωρήσετε στο επόμενο βήμα μόνο εάν η απάντηση βρίσκεται στην κατάσταση ΟΛΟΚΛΗΡΩΜΕΝΟ.
Λήψη του αποτελέσματος πληρωμής
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é:
Μεταβλητή
transactionId
Μορφή
string
Περιγραφή
Το αναγνωριστικό συναλλαγής που λάβατε στα προηγούμενα βήματα.
Παράδειγμα
4414c640-2db7-11ec-910a-91880dadec20
Οι πιθανοί κωδικοί απαντήσεων είναι:
Απάντηση
RC200
RC404
Αναφορά
OK - παρέχονται λεπτομέρειες συναλλαγής
Δεν βρέθηκε καμία συναλλαγή για το τρέχον TID.
Αναφορά
Επιτυχής απάντηση στο αίτημά σας.
Αυτή η κατάσταση εμφανίζεται όταν δεν έχει βρεθεί το αναγνωριστικό συναλλαγής για τη συσκευή σας.
Περιγραφή
Η συναλλαγή ολοκληρώθηκε!
Ελέγξτε το αναγνωριστικό συναλλαγής.
Η απάντηση περιέχει τις ακόλουθες μεταβλητές ανάλογα με τον κωδικό απάντησης:
Μεταβλητή
αποτέλεσμα
responseMessage
transanctionId
transactionOperation
transactionType
merchantID
tid
currencyCode
ποσό
TipAmount
cardNumber
cardDataEntry
referenceNumber
invoiceNumber
ημερομηνία
emvAppLabel
sequenceNumber
exceptionId
τύπος
μήνυμα
πλαίσιο
Μορφή
string
string
string
string
string
string
string
string
αριθμός
αριθμός
string
string
string
string
string
string
string
string
string
string
string
Περιγραφή
Αποτέλεσμα συναλλαγής, πιθανές τιμές [ ACCEPTED, DECLINED, CANCELLED ] όπου: ACCEPTED - η συναλλαγή εγκρίθηκε επιτυχώς DECLINED - η συναλλαγή απορρίφθηκε για κάποιο λόγο CANCELLED - αν η συναλλαγή ακυρώθηκε από τον χειριστή ή τον πελάτη.
Μια πιο λεπτομερής περιγραφή της τιμής που προκύπτει.
Εσωτερικό αναγνωριστικό εργασίας
Πιθανές τιμές: ""ΠΩΛΗΣΗ"" ""ΑΚΥΡΩΣΗ"" ""ΕΠΙΣΤΡΟΦΗ"" Τύπος λειτουργίας / συναλλαγής."
Πιθανές τιμές "CASH" "CARD" "GO_CRYPTO"
Μόνο για συναλλαγές με κάρτα - Αναγνωριστικό υποκαταστήματος.
ID της συναλλαγής που δημιουργήθηκε από το τερματικό
Κωδικός νομίσματος (ISO 4217)
Ποσό συναλλαγής με 2 δεκαδικά ψηφία (400 CZK).
Εισαγωγή ποσού φιλοδωρήματος με 2 δεκαδικά ψηφία (30 CZK).
Κρυμμένος αριθμός κάρτας.
Μέθοδος φόρτωσης της κάρτας - μαγνητική λωρίδα, τσιπ ή ανέπαφη κάρτα.
Αριθμός αναφοράς συναλλαγής που λαμβάνεται από την τιμή της εργασίας αίτησης: originReferenceNum
Ημερομηνία και ώρα έγκρισης της συναλλαγής
Μάρκα EMV της κάρτας που λαμβάνεται από τα δεδομένα της κάρτας
Αριθμός που παράγεται από την πλευρά του GP
Ψευδο-μοναδικό αναγνωριστικό εξαίρεσης. Μπορεί να χρησιμεύσει ως "αναγνωριστικό υποστήριξης" που ο χρήστης μπορεί να πει στην υποστήριξη να διερευνήσει.
Τύπος εξαίρεσης
Έκθεση εξαιρέσεων
Πλαίσιο απαλλαγής - περαιτέρω πληροφορίες.
Παράδειγμα
ΑΠΟΔΕΧΘΗΚΕ
null
4414c640-2db7-11ec-910a-91880dadec20
VOID
ΚΑΡΤΑ
343382001
483591
40000
-
1233
null
FD123456
2020-09-16T09:31:16.000Z
null
102304128
FujIk6
VALIDATION_EXCEPTION
Πολύ αδύναμος κωδικός πρόσβασης
[INSUFFICIENT_DIGIT]:{minimumRequired=1, matchingCharacterCount=0, validCharacters=0123456789, matchingCharacters=}
RC 200
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
RC 404
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΟΧΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
ΝΑΙ
Εάν θα δημιουργήσετε ή θα εκτυπώσετε την απόδειξη από την πλευρά σας, συνιστούμε να ελέγξετε ποια πεδία είναι υποχρεωτικά και πρέπει να εκτυπωθούν/εμφανιστούν στην απόδειξη. Μια περιγραφή είναι διαθέσιμη εδώ.