Transakce návrat umožňuje vrátit peníze na jakoukoliv kartu zákazníka bez potřeby dohledání předešlé prodejní transakce.
Průběh návratu je následující:
Vytvoření návratu
The transaction can be initiated by calling:
gptom://transaction/refund?…
kde jsou použity následující parametry pro sestavení zprávy včetně amsID, které je přiděleno pro každou platbu:
Variable/Field
Format/Format
Description/Description
Example
amount
long
CZ: Transaction amount with two decimal places.
1000 (=10CZK/EURO)
clientID
string
EN: Transaction amount with two decimal places.
redirectUrl
string
CZ: Unique amsID that you will receive at the time of payment.
fb://Success
originReferenceNum
string
EN: The unique amsID that you will receive upon payment.
abc123
preferableReceiptType
enum (sms,email,qr,print)
CZ: URL of your application to which we redirect the client after the cancellation is completed.
text
printByPaymentApp
bool
EN: The URL of your application to which we will redirect the client after the cancellation is complete.
true/false
clientPhone
string
CZ: Reference number up to 20 characters - suitable for invoice number, payment - can be used for your payment matching to sales or orders.
+420606505404
clientEmail
string
EN: Reference number up to 20 characters - suitable for invoice number, payment - can be used for your matching of payments to sales or orders.
info@gptom.com
CZ: In case of sending a receipt from the GP tom application, it is possible to predefine the method of sending the receipt via API. Possible values are:
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
CZ: Defines whether the receipt is passed to the client by your application or by GP tom. The default value is true (i.e. GP tom will offer the method of passing the receipt to the client). If you send the value “false”, we will return the user to your application immediately after the transaction and it is 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.
CZ: Client's phone number.
EN: Client phone number.
CZ: Client's email address.
EN: Client email address.
Example call:
gptom://transaction/refund?amount=1000&preferableReceiptType=QR&clientPhone=+420606505404&clientID=123&printByPaymentApp=true&redirectUrl=gp://transaction/refund&clientEmail=info@gptom.com
The answer will contain the following fields:
Field/Field
Description/Description
Example/Example
TASK STATUS
CZ: Gives the answer in which state the request ended.
COMPLETED
terminalID
EN: Gives information in which state has your request ended.
CANCELED
amount
CZ: ID of the terminal on which the transactions are processed. Identifies the terminal in GP systems.
ERROR
batchNumber
EN: Unique terminal ID, on which the transaction is processed.
12345678
emvAppLabel
CZ: The amount determines the volume of the transaction. This amount is calculated in the domestic currency used by the terminal. For a closing, it includes all card transactions, credited minus debited.
10
amsID
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.
1
referenceNumber
CZ: Identifies the closing number. To be filled in if a deadline is requested.
Visa Debit
sequenceNumber
EN: Defines batch number. Present during the close batch transaction.
transactionType
CZ: The name of the EMV that was used in the payment.
ABC123
date
EN: Card label of used card
001000000
currencyCode
CZ: Unique transaction number.
CARD
merchantID
EN: Unique transaction number.
2024-10-29T12:14:00.112Z
TipAmount
CZ: Reference number entered when requesting payment.
EUR
totalAmount
EN: Reference number entered during the payment
result
CZ: Used for cancellation transactions. Use the received value that was part of the transaction you want to cancel.
2
cardEntryMode
EN: Used for transaction cancellation. Used the received value which was a part of transaction you want to cancel.
12
transactionID
EN: Defines the transaction type.
0 = completed
authorizationCode
EN: Defines type of transaction.
-1 = declined
cardNumber
CZ: Indicates the time of the transaction.
CONTACTLESS
pinOk
EN: Give date of transaction.
001000000
CODE
CZ: Three-digit ISO currency codes - see the Wiki page for a list.
123456
emvAid
EN: Three chars currency ISO code.
0001
cardType
CZ: Unique merchant ID, usually representing a location ID.
true/false
EN: Unique merchant ID, usually location ID
approved
CZ: Tips. Filled in if it has been entered.
A0000000031010
EN: Tip. Filled in if needed.
VISA
CZ: Indicates the total transaction line (including tip).
MASTER
EN: Indicates the total amount of transaction (including tip)
CZ: Response to request.
EN: Result to the request.
CZ: Identifies the method of entering card data, such as chip, contactless, Magstripe, etc.
EN: Defines how the card was read: magstripe, chip or contactless.
CZ: Unique ID generated by the payment application during the transaction registration process.
EN: Unique ID generated by payment app during the transaction registration process.
CZ: To be filled in only if the transaction ends up being approved.
EN: Is present just if the transaction is processed.
CZ: Card number (PAN). It is present in masked form.
EN: Card Number (PAN). It is present in masked form.
CZ: Displays the result of the transaction on authorization.
EN: Shows transaction result on the authorization side.
EN: Identifies the EMV application used to process the transaction.
EN: Identifies the EMV app used for transaction processing.
CZ: Identifies the type of card used.
EN: Identifies used card type.