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.

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)
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'	✅

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"
				+ "&show_receipt="+true
				+ "&show_transaction_result="+true
				+ "&show_rating="+true ));


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
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'

A Rebate response result for an approved refund 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 Wallet, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!