Co přesně je dávka? Každá transakce, kterou vytvoříte, patří do tzv. dávky. Stejně jako účtenka má každá dávka své číslo a je balíčkem transakcí. Uzávěrka je administrativní operace, pomocí které terminál uzavře dávku a vyzve systémy, aby se dávka uzavřela a otevřela nová.
Inicializace uzávěrky
Transakci lze iniciovat zavoláním:
gptom://batch/close?…
kde jsou použity následující parametry pro sestavení zprávy:
Proměnná/Field
Formát/Format
Popis/Description
Příklad
clientID
string
redirectUrl
string
CZ: URL vaší aplikace na kterou přesměrujeme klienta po dokončení uzávěrky.
EN: The URL of your application to which we will redirect the client after the close batch is complete.
EN: The URL of your application to which we will redirect the client after the close batch is complete.
fb://Success
printByPaymentApp
bool
CZ: Definuje, zda účtenku klientovi předá vaše aplikace nebo GP tom. Výchozí hodnota je true (tedy GP tom nabídne způsob předání účtenky klientovi). Pokud pošlete hodnotu “false”, ihned po transakci vrátíme uživatele do vaší aplikace a předání účtenky je na vás.
EN: Defines whether the receipt is passed to the client by your application or GP tom. The default value is true (i.e. GP will offer a way to pass the receipt to the client). If you send a value of "false", we return the user to your app immediately after the transaction and it's up to you to pass the receipt.
EN: Defines whether the receipt is passed to the client by your application or GP tom. The default value is true (i.e. GP will offer a way to pass the receipt to the client). If you send a value of "false", we return the user to your app immediately after the transaction and it's up to you to pass the receipt.
true/false
preferableReceiptType
enum (sms,email,qr,print)
CZ: V případě odeslání účtenky z aplikace GP tom je možné přes API předdefinovat způsob odeslání účtnky. Možné hodnoty jsou:
EN: In the case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via the API. Possible values are:
PHONE
EMAIL
QR
PRINT
EN: In the case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via the API. Possible values are:
PHONE
QR
sms
clientPhone
string
CZ: Telefonní číslo klienta.
EN: Client phone number.
EN: Client phone number.
+420606505404
clientEmail
string
CZ: Emailová adresa klienta.
EN: Client email address.
EN: Client email address.
info@gptom.com
Příklad volání:
gptom://batch/close?preferableReceiptType=QR&redirectUrl=gp://batch/close&clientEmail=info@gptom.com&clientID=223&printByPaymentApp=true&clientPhone=+420606505404
Odpověď bude obsahovat následující pole:
Proměnná/Field
Formát/Format
Popis/Description
Příklad/Example
TASK STATUS
CZ: Dává odpověď v jakém stavu skončil daný požadavek.
EN: Gives information in which state has your request ended.
EN: Gives information in which state has your request ended.
COMPLETED
CANCELED
ERROR
CANCELED
ERROR
communicationId
12345678
voidAmount
CZ: Celková výška stornovaných transakcí.
EN: Total amount of voided transactions.
EN: Total amount of voided transactions.
5
totalAmount
CZ: Celková částka uzávěrky.
EN: Total amount of close batch.
EN: Total amount of close batch.
100
totalCount
CZ: Počet všech transakcí v uzávěrce.
EN: Number of all transactions in the close batch.
EN: Number of all transactions in the close batch.
15
saleAmount
CZ: Celková výška transakcí PRODEJ.
EN: Total amount of SALE transactions.
EN: Total amount of SALE transactions.
105
voidCount
CZ: Počet stornovaných transakcí v uzávěrce.
EN: Amount of voided transactions in the close batch.
EN: Amount of voided transactions in the close batch.
1
previousBatchDate
CZ: Datum předchozí uzávěrky.
EN: Date of the previous batch.
EN: Date of the previous batch.
2024-10-20T15:11:08.152Z
date
CZ: Datum provedení aktuální uzávěrky.
EN: Date of processing this close batch.
EN: Date of processing this close batch.
2024-10-29T12:14:00.198Z
saleCount
CZ: Počet transakcí PRODEJ v uzávěrce.
EN: Number of SALE transactions in the close batch.
EN: Number of SALE transactions in the close batch.
14
firstTransactionDate
CZ: Datum první transakce v uzávěrce.
EN: Date of the first transaction in the close batch.
EN: Date of the first transaction in the close batch.
2024-10-21T17:19:20.015Z
subBatches
CZ: Zde najdete rozpis dle platební metody.
EN: Here you will find overview per payment method.
EN: Here you will find overview per payment method.
CASH
CARD
CARD