Transakce prodej je základní platební operace, která zajišťuje převod stanovené částky z bankovního účtu držitele karty na účet obchodníka.
Pokud jde o průběh platby, postup je následující:
Vytvoření transakce
Transakci lze iniciovat zavoláním:
gptom://transaction/create?…
kde jsou použity následující parametry pro sestavení zprávy:
Proměnná/Field
Formát/Format
Popis/Description
Příklad
Betrag
MANDATORY
MANDATORY
long
CZ: Částka transakce s dvěma desetinnými místy.
EN: Transaction amount with two decimal places.
EN: Transaction amount with two decimal places.
1000 (=10CZK/EUR)
clientID
string
CZ: Volitelná kontrola přihlášeného uživatele. Zde se kontroluje API klíč terminálu.
EN: Optional check of the logged in user. Here the terminal API key is checked.
EN: Optional check of the logged in user. Here the terminal API key is checked.
originReferenceNum
string
CZ: Referenční číslo až 20 znaků - vhodné pro číslo faktury, platby - je možné použít pro vaše párování platby k prodejům či objednávkám.
Reference number up to 20 characters - suitable for invoice number, payment - can be used for your matching of payments to sales or orders.
Reference number up to 20 characters - suitable for invoice number, payment - can be used for your matching of payments to sales or orders.
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.
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.
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.
wahr/falsch
TipAmount
long
CZ: V restauracích můžete požádat zákazníka o přidání spropitného, kde spropitného je zadáno z Vašeho systému. Tato částka se pak přičte k původní částce zadané obchodníkem.
EN: In restaurants, you can ask the customer to add a tip, where the tip is entered in your system. This amount is then added to the original amount entered by the merchant.
EN: In restaurants, you can ask the customer to add a tip, where the tip is entered in your system. This amount is then added to the original amount entered by the merchant.
1000 (=10CZK/EUR)
redirectUrl
string
CZ: URL vaší aplikace na kterou přesměrujeme klienta po dokončení platby.
EN: The URL of your application to which we will redirect the client after completing the payment.
EN: The URL of your application to which we will redirect the client after completing the payment.
fb://success
TipCollect
bool
CZ: Volitelné pole, které vyvolává obrazovku zadání spropitného v aplikaci GP tom. Po zadání spropitného v aplikaci se následně zobrazí obrazovka pro přiložení karty. Pro vyvolání této obrazovky je potřeba mít také aktivované spropitné v aplikaci.
EN: An optional field that brings up the tip entry screen in the GP tom application. After entering the tip in the application, a screen for attaching the card will be displayed. You also need to have tipping enabled in the app to bring up this screen.
EN: An optional field that brings up the tip entry screen in the GP tom application. After entering the tip in the application, a screen for attaching the card will be displayed. You also need to have tipping enabled in the app to bring up this screen.
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:
TELEFON
EMAIL
QR
DRUCKEN
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:
TELEFON
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
transactionType
string
DE: Die Transaktionsart legt die Art der Transaktion fest, die Sie einleiten möchten. Die verfügbaren Werte sind:
EN:Transaction Type defines the type of transaction you want to initiate. Available values are:
CASH
KARTE
KONTO_BEZAHLUNG
BLIK_PAYMENT
PAYMENT_GATEWAY
EN:Transaction Type defines the type of transaction you want to initiate. Available values are:
CASH
KARTE
KONTO_BEZAHLUNG
BLIK_PAYMENT
PAYMENT_GATEWAY
KARTE
Příklad volání:
gptom://transaction/create?originReferenceNum=12345&amount=2&clientID=123&tipCollect=true&preferableReceiptType=QR&redirectUrl=gp://transaction/create&printByPaymentApp=true&clientPhone=+420606505404&clientEmail=info@gptom.com&tipAmount=1
Odpověď bude obsahovat následující pole:
Pole/Field
Formát
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.
ABGESCHLOSSEN
CANCELED
ERROR
CANCELED
ERROR
terminalID
CZ: ID des Terminals, an dem die Transaktionen verarbeitet werden. Identifiziert das Terminal in GP-Systemen.
DE: Eindeutige Terminal-ID, mit der die Transaktion verarbeitet wird.
DE: Eindeutige Terminal-ID, mit der die Transaktion verarbeitet wird.
12345678
Betrag
CZ: Der Betrag bestimmt das Volumen der Transaktion. Dieser Betrag wird in der vom Terminal verwendeten Landeswährung berechnet. Für einen Abschluss umfasst er alle Kartentransaktionen, gutgeschrieben minus belastet.
DE: Der Betrag bestimmt das Volumen der Transaktion. Dieser Betrag wird in der vom Terminal verwendeten Landeswährung berechnet. Zum Tagesabschluss enthält er alle Kartentransaktionen, Gutschriften abzüglich Belastungen.
DE: Der Betrag bestimmt das Volumen der Transaktion. Dieser Betrag wird in der vom Terminal verwendeten Landeswährung berechnet. Zum Tagesabschluss enthält er alle Kartentransaktionen, Gutschriften abzüglich Belastungen.
10
batchNumber
CZ: Kennzeichnet die Abschlussnummer. Anzugeben, wenn eine Frist beantragt wird.
DE: Definiert die Chargennummer. Wird bei der Transaktion "Charge abschließen" angezeigt.
DE: Definiert die Chargennummer. Wird bei der Transaktion "Charge abschließen" angezeigt.
1
emvAppLabel
CZ: Der Name des EMV, der bei der Zahlung verwendet wurde.
EN: Card label of used card
EN: Card label of used card
Visa Debit
amsID
CZ: Unikátní číslo transakce.
EN: Unique transaction number.
EN: Unique transaction number.
emvAid
CZ: Identifikuje aplikaci EMV používanou pro zpracování transakce.
EN: Identifies the EMV app used for transaction processing.
EN: Identifies the EMV app used for transaction processing.
A0000000031010
referenzNummer
CZ: Bei der Zahlungsanforderung angegebene Referenznummer.
EN: Reference number entered during the payment
EN: Reference number entered during the payment
ABC123
sequenceNumber
CZ: Wird für Stornotransaktionen verwendet. Verwenden Sie den empfangenen Wert, der Teil der Transaktion war, die Sie stornieren möchten.
DE: Wird für die Stornierung von Transaktionen verwendet. Verwendet den empfangenen Wert, der Teil der Transaktion war, die Sie stornieren möchten.
DE: Wird für die Stornierung von Transaktionen verwendet. Verwendet den empfangenen Wert, der Teil der Transaktion war, die Sie stornieren möchten.
001000000
cardType
CZ: Identifikuje použitý typ karty.
EN: Identifies used card type.
EN: Identifies used card type.
VISA
MASTER
MASTER
transactionType
CZ: Definuje typ transakce.
EN: Defines type of transaction.
EN: Defines type of transaction.
KARTE
Datum
CZ: Udává čas transakce.
EN: Give date of transaction.
EN: Give date of transaction.
2024-10-29T12:14:00.112Z
currencyCode
CZ: Dreistellige ISO-Währungscodes - siehe die Wiki-Seite für eine Liste.
DE: Dreistelliger ISO-Code der Währung.
DE: Dreistelliger ISO-Code der Währung.
EUR
merchantID
CZ: Eindeutige Händlerkennung, die in der Regel eine Standortkennung darstellt.
DE: Eindeutige Händler-ID, normalerweise Standort-ID
DE: Eindeutige Händler-ID, normalerweise Standort-ID
TipAmount
CZ: Tipps. Wird ausgefüllt, wenn es eingegeben wurde.
DE: Tipp. Bei Bedarf auszufüllen.
DE: Tipp. Bei Bedarf auszufüllen.
2
totalAmount
CZ: Udává celkovou čásku transakce (včetně spropitného)
EN: Indicates the total amount of transaction (including tip)
EN: Indicates the total amount of transaction (including tip)
12
Ergebnis
CZ: Odpověď na požadavek.
EN: Result to the request.
EN: Result to the request.
0 - approved transaction
-1 - declined transaction
-1 - declined transaction
cardEntryMode
CZ: Identifikuje způsob zadávání údajů o kartě, jako je čip, bezkontaktní, Magstripe atd.
EN: Defines how the card was read: magstripe, chip or contactless.
EN: Defines how the card was read: magstripe, chip or contactless.
CONTACTLESS
transaktionsID
CZ: Nur auszufüllen, wenn die Transaktion schließlich genehmigt wird.
DE: Ist nur vorhanden, wenn die Transaktion bearbeitet wird.
DE: Ist nur vorhanden, wenn die Transaktion bearbeitet wird.
123456
authorizationCode
CZ: Eindeutige ID, die von der Zahlungsanwendung während der Registrierung der Transaktion generiert wird.
EN: Unique ID generated by payment app during the transaction registration process.
EN: Unique ID generated by payment app during the transaction registration process.
001000000
pinOk
wahr/falsch
cardNumber
CZ: Číslo karty (PAN). Je přítomen v maskované formě.
EN: Card Number (PAN). It is present in masked form.
EN: Card Number (PAN). It is present in masked form.
0001
CODE
CZ: Zobrazuje výsledek transakce na autorizaci.
EN: Shows transaction result on the authorization side.
EN: Shows transaction result on the authorization side.
accepted