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
amount
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
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.
true/false
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:
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
transactionType
string
CZ: Typ transakce definuje typ transakce, kterou chcete zahájit. Dostupné hodnoty jsou:
EN:Transaction Type defines the type of transaction you want to initiate. Available values are:
CASH
CARD
EN:Transaction Type defines the type of transaction you want to initiate. Available values are:
CASH
CARD
CASH/CARD
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.
COMPLETED
CANCELED
ERROR
CANCELED
ERROR
terminalID
CZ: ID terminálu, na kterém jsou transakce zpracovávány. Identifikuje terminál v systémech GP.
EN: Unique terminal ID, on which the transaction is processed.
EN: Unique terminal ID, on which the transaction is processed.
12345678
amount
CZ: Částka určuje objem transakce. Tato částka se počítá v domácí měně, kterou používá terminál. U uzávěrky obsahuje všechny karetní transakce, připsané mínus debetní.
EN: The amount determines the volume of the transaction. This amount is calculated in the domestic currency used by the terminal. At close day, it contains all card transactions, credited minus debit.
EN: The amount determines the volume of the transaction. This amount is calculated in the domestic currency used by the terminal. At close day, it contains all card transactions, credited minus debit.
10
batchNumber
CZ: Identifikuje číslo uzávěrky. Vyplňuje se v případě požadavku na uzávěrku.
EN: Defines batch number. Present during the close batch transaction.
EN: Defines batch number. Present during the close batch transaction.
1
emvAppLabel
CZ: Název EMV, které bylo použito při platbě.
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
referenceNumber
CZ: Referenční číslo zadané při požadavku na platbu.
EN: Reference number entered during the payment
EN: Reference number entered during the payment
ABC123
sequenceNumber
CZ: Používá se pro storno transakce. Použijte obdrženou hodnotu která byla součástí transakce, kterou chcete zrušit.
EN: Used for transaction cancellation. Used the received value which was a part of transaction you want to cancel.
EN: Used for transaction cancellation. Used the received value which was a part of transaction you want to cancel.
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.
CARD
date
CZ: Udává čas transakce.
EN: Give date of transaction.
EN: Give date of transaction.
2024-10-29T12:14:00.112Z
currencyCode
CZ: Třímístné kódy ISO měny – seznam najdete na stránce Wiki.
EN: Three chars currency ISO code.
EN: Three chars currency ISO code.
EUR
merchantID
CZ: Jedinečné ID obchodníka, obvykle představuje ID lokality.
EN: Unique merchant ID, usually location ID
EN: Unique merchant ID, usually location ID
tipAmount
CZ: Spropitné. Vyplněno v případě, že bylo zadáno.
EN: Tip. Filled in if needed.
EN: Tip. Filled in if needed.
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
result
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
transactionID
CZ: Vyplňuje se pouze v případě, že transakce skončí jako schválená.
EN: Is present just if the transaction is processed.
EN: Is present just if the transaction is processed.
123456
authorizationCode
CZ: Jedinečné ID generované platební aplikací během procesu registrace transakce.
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
true/false
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