Rebate request

An overview of the Rebate message for Android.

• Overview
• Rebate request
• Rebate response
• Key to card terminal product categories
• Get Support

Overview

👉 The Rebate request is utilized to process a rebate to a Visa, Mastercard, or Maestro card (where supported by the customer’s bank).

The client app must implement a mechanism to send messages using Android intents and URI calls and to receive the result in a custom URI callback.

• Rebate request originating from the client app to initiate a request for a Rebate transaction.
• Rebate response originating from the ‘Viva.com Terminal’ application to return the result of a Rebate transaction.

Rebate request

For a typical Rebate request, or refund, the client app must provide the following information:

Field	Description	Example	Required	Card terminal support	Character limit	Type
scheme	The Viva's custom URL scheme, the host and the version.	'vivapayclient://pay/v1'	✅
merchantKey	The merchant's key. For successful validation, should not be empty. Deprecated: you may pass any value.	'SG23323424EXS3'
appId	The client app ID. For successful validation, should not be empty.	'com.example.myapp'	✅
action	Rebate. For successful validation, should not be empty.	'send_money_rebate'	✅
referenceNumber	The STAN number of the transaction to be cancelled. If empty, after card presentment, the app will provide a list of the last 3 transactions made with the presented card, allowing the user to select the transaction to be canceled. If action is cancel and if not empty should be integer bigger than zero.	'123789'			integer (int32)
amount	The amount to be refunded in cents	'100'	✅		10	integer (int32)
sourceCode	The store/source code that will be linked to the transaction. If a source code parameter is not specified, the source code assigned to the terminal will automatically be associated with the transaction. When the sourceCode is specified, the transaction will be linked to the sourceCode accordingly.	[A payment source (physical store) that is associated with the transaction] How to create a payment source for CP payments			20	integer (int32)
show_receipt	A flag indicating if the receipt and transaction result will be shown. If true both transaction result and receipt will be shown. If false receipt will not be shown and result will be shown if show_transaction_result is true.	'true'				Boolean
show_transaction_result	A flag indicating if transaction result will be shown.	'true'				Boolean
show_rating	A flag indicating if the rating flow will be shown.	'true'				Boolean
callback	The URI callback that will handle the result. For successful validation, should not be empty.	'mycallbackscheme://result'	✅
aadeProviderId [*]	👉 Integration with Provider (ΥΠΑΗΕΣ) Set the Unique Number to identify your Provider VivaDemo - 999(provider id for testing purposes) SoftOne - 101 EnterSoft - 102 Impact - 103 Epsilon Net - 104 Novus Conceptus - 105 Cloud Services IKE - 106 Primer Software - 107 ILYDA = 108 Prosvasis = 109 MAT = 110 Simply = 111 Kappa = 112 SBZ = 113 OneSys = 114 ORIAN = 115 TESAE = 116 Karpodinis = 117 Cloud T = 118 Πάροχος Λύσεων Πληροφορικής Α.Ε. = 119 👉 Integration with ΦΗΜΑΣ (Φορολογικός Ηλεκτρονικός Μηχανισμός Ασφαλείας) For integration through ΦΗΜΑΣ, please specify as `aadeProviderId' the value 800	Integration with Provider (ΥΠΑΗΕΣ) 999 Integration with ΦΗΜΑΣ (Φορολογικός Ηλεκτρονικός Μηχανισμός Ασφαλείας) 800	Please note that this parameter apply only for Greek merchants.		3	Numeric
aadeProviderSignatureData [*]	👉 Integration with Provider (ΥΠΑΗΕΣ) The unencrypted signature that includes the fields below with semicolon as a delimiter “;”: Receipt UID MARK (Unique ID provided by AADE - commonly null as this provider after the end of the transaction) Date and time of the Signature Amount to be paid Sum Amount without TAX VAT percentage Sum Amount with TAX TID 👉 Integration with ΦΗΜΑΣ (Φορολογικός Ηλεκτρονικός Μηχανισμός Ασφαλείας) Use ECR TOKEN as in A.1098/2023 Request A/S< session number>/F< amount>:978:2 /D< datetime>/R< ecr-id>/H< operator-number>/T0 /M/Q< mac>} Result R/S< session number>/R< ecr-id>/T< receipt-number> /Μ/C00/D< trans-data>{/P< prn-data>}}	Integration with Provider (ΥΠΑΗΕΣ) AD33729F4ED749928AAFA00B90EE4EA91551BAC1;;20231204080313;1051;10000;2400;12400;POS_1	Please note that this parameter apply only for Greek merchants.		200	Alphanumeric
aadeProviderSignature [*]	👉 Integration with Provider (ΥΠΑΗΕΣ) The fields of providerSignatureFields encrypted using a public key and the Elliptic Curve Digital Signature Algorithm (ECDSA): Algorithm: ECDSA Curve: NISTP256 HASH: SHA256 The signature is sent to POS in base64 format 👉 Integration with ΦΗΜΑΣ (Φορολογικός Ηλεκτρονικός Μηχανισμός Ασφαλείας) Use SessionKey as in A.1098/2023	Integration with Provider (ΥΠΑΗΕΣ) o0094r3Yk3KTqASLkW3evlDsnIg/ZAdUUf6UCXDtjqpI/dquzAT4WNX3yzS/GLciVNbT75H4pj8hLOV0EpHtzw=="	Please note that this parameter apply only for Greek merchants.			Alphanumeric

[*] These parameters are only applicable in Greece

The above information elements must create a URI call, i.e.

Intent payIntent = new Intent(Intent.ACTION_VIEW, Uri.parse( "vivapayclient://pay/v1"
				+ "?merchantKey="MY_MERCHANT_KEY"
				+ "&appId=com.example.myapp"
				+ "&action=send_money_rebate"
				+ "&callback=mycallbackscheme://result"
				+ "&amount=100"
        + "&sourceCode=6532"
				+ "&show_receipt="+true
				+ "&show_transaction_result="+true
				+ "&show_rating="+true
                + "&aadeProviderId=999"
                + "&aadeProviderSignatureData=AD33729F4ED749928AAFA00B90EE4EA91551BAC1;;20231204080313;1051;10000;2400;12400;POS_1"
                + "&aadeProviderSignature=o0094r3Yk3KTqASLkW3evlDsnIg/ZAdUUf6UCXDtjqpI/dquzAT4WNX3yzS/GLciVNbT75H4pj8hLOV0EpHtzw=="));


payIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
//        Those two flags should be added for paydroid implementations
//        payIntent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
//        payIntent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
                startActivity(payIntent);

Rebate response

After executing a Rebate transaction, or refund, the ‘Viva.com Terminal’ application responds with a Rebate response result to indicate if the refund has been approved or not.

The result is received as a URI in the callback activity intent:

Uri result = getIntent().getData()

The table below summarises the contents of an approved response.

Field	Description	Example	Card terminal support
callback	The URI callback that will handle the result.	'mycallbackscheme://result'
status	The status of the transaction	'success'
message	A string containing information about the transaction status.	'Transaction successful'
action	Rebate transaction.	'send_money_rebate'
amount	The amount in cents without any decimal digits.	'1200' = 12 euro
sourceCode	The source code associated with the transaction.	'2412'
cardType	The card type.	'Visa'
accountNumber	The card number. Note that only the 6 first and the 4 last digits are provided. All other digits are masked with stars.	'479275\*\*\*\*\*\*9999'
tid	A 12-character string indicating the terminal's TID number.	'16016684'
transactionDate	The transaction date in ISO 8601 format.	'2019-09-13T12:14:19.8703452+03:00'
transactionId	A unique identifier for the transaction.	'a78e045c-49c3-4743-9071-f1e0ed71810c'
aadeTransactionId	An AADE-specific transaction ID. Format: Acquirer Unique code + RRN + Authorization code. Example: ‘116’ + ‘123456833121’ + ‘690882’ = '116123456833121690882'	'116123456833121690882'

A Rebate response result for an approved refund looks as follows:

A sale response for a successful Rebate transaction using AADE parameters looks as follows:

It is expected that certain transactions will fail for various reasons. A Rebate response result for a failed refund looks as follows:

The structure of the message is the same as in the case of an approved Rebate.

Key to card terminal product categories

To understand the icons used on the above tables, see the below table.

Product category	Terminal models	Icon
Android Card Terminals	Android Card Terminal Ethernet, Android Card Terminal 4G, Mobile Card Terminal Plus, Mobile Card Terminal.
'Viva.com Terminal' application for Android	Mini Card Reader, Pocket Card Terminal connected via Bluetooth or USB to the 'Viva.com Terminal' application for Android.
Linux Card Terminals	Countertop, IM20, S900, S800, D200.

Get Support

If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!