Android app integration
Information on our Android app integration solution.
Overview
Please see below for information on integrating with Viva Wallet’s Android Viva Terminal App.
ToP (Tap-on-Phone) is for Android devices with Android OS 8.1 or above
Messages
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. Overall the following messages are available:
Sales-related requests
- Sale request originating from the client app to initiate a request for a new Sale transaction.
- Multimerchant Sale request originating from the client app to initiate a request for a new Multimerchant Sale transaction.
- Pre-auth request originating from the client app to initiate a request for a new Pre-auth transaction.
- Capture Pre-auth request originating from the client app to initiate a request for a Capture Pre-auth transaction.
- Cancel request originating from the client app to initiate a request for a Cancel transaction.
- Abort request originating from the client app to abort (if possible) the last Sale request.
- Batch request originating from the client app to open or close a batch.
- Reprint request originating from the client app to reprint a transaction receipt.
- Transaction Details request originating from the client app to request transaction details.
- Foreground request originating from the client app to bring Card terminal app to foreground.
Configuration-related requests
- Set Mode request originating from the client app to set the card terminal mode.
- Set Printing Settings request originating from the client app to change the Printing Settings.
- Get Printing Settings request originating from the client app to get the Printing Settings of the Viva Terminal App.
- Send logs request originating from the client app to trigger the application to upload logs
- POS Activation request originating from the client app to trigger the POS activation.
- Get Activation Code request originating from the client app to trigger the Get Activation Code request.
- Decimal Amount Mode request originating from the client app to initiate a request for a decimal amount mode.
- Reset request originating from client app to reset the Viva Terminal App.
Callback activity
The client app must provide a callback activity declare in AndroidManifest.xml
, in order to receive the response results.
<activity
android:name="com.example.URLResponseActivity"
android:label="Payment Result">
<intent-filter>
<action android:name="android.intent.action.VIEW"/>
<action android:name="com.example.URLResponseActivity"/>
<category android:name="android.intent.category.DEFAULT"/>
<category android:name="android.intent.category.BROWSABLE"/>
<!-- Provide your own scheme here and reference it when you send a message -->
<data
android:scheme="mycallbackscheme"
android:host="result"/>
</intent-filter>
</activity>
Key to card terminal product categories
To understand the icons used on the above table, 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 Terminal App for Android | Mini Card Reader, Pocket Card Terminal connected via Bluetooth or USB to the Viva Terminal App 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!