Transakce storno patří mezi základní platební operace, která zajišťuje storno již provedené platební transakce zpět na účet držitele karty.
Průběh storna je následující:
Vytvoření storna
Transakci lze iniciovat zavoláním:
gptom://transaction/cancel?…
kde jsou použity následující parametry pro sestavení zprávy včetně amsID, které je přiděleno pro každou platbu:
Proměnná/Field
Formát/Format
Popis/Description
Příklad
clientID
string
amsID
MANDATORY
MANDATORY
string
CZ: Unikátní amsID, které dostanete při platbě.
EN: The unique amsID that you will receive upon payment.
EN: The unique amsID that you will receive upon payment.
redirectUrl
string
CZ: URL vaší aplikace na kterou přesměrujeme klienta po dokončení storna.
EN: The URL of your application to which we will redirect the client after the cancellation is complete.
EN: The URL of your application to which we will redirect the client after the cancellation is complete.
fb://Success
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
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
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://transaction/cancel?amsID=123&preferableReceiptType=QR&clientPhone=+420606505404&clientID=123&printByPaymentApp=true&redirectUrl=gp://transaction/cancel&clientEmail=info@gptom.com
Odpověď bude obsahovat následující pole:
Pole/Field
Popis/Decription
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.
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
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 = completed
-1 = declined
-1 = declined
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: 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
authorizationCode
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
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
pinOk
true/false
CODE
CZ: Zobrazuje výsledek transakce na autorizaci.
EN: Shows transaction result on the authorization side.
EN: Shows transaction result on the authorization side.
approved