Set Mode request

An overview of the Set Mode request message for Android.

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

Overview

👉 The Set Mode request is used to set the operation mode of the ‘viva.com | Terminal’ application (Attended, Semi-Unattended, Full-Unattended or ECR-Controlled).

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.

• Set Mode request originating from the client app to set the card terminal mode.
• Set Mode response originating from the card terminal the result of setting the card terminal mode.

Set Mode request

Using this action, the user can set the operation of the app into one of four modes:

• 0️⃣ | Attended mode: This is the default operation of the app
• 1️⃣ | Semi-Unattended mode: All the app dialogs and screens are auto dismissable with timeouts. The app returns the results and the focus to the caller 3rd app
• 2️⃣ | Full-Unattended mode: All the app dialogs and screens are auto dismissable with timeouts. The app returns the results to the caller 3rd app which is mandatory not to have UI and be a service
• 3️⃣ | ECR-Controlled: Allows third-party apps to apply ‘viva.com | Terminal’ application controls

For a typical Set Mode request, the client app must provide the following information:

Field	Description	Example	Required	Card terminal support	Character limit	Type
appId	The client app ID. For successful validation, should not be empty.	'com.example.myapp'	✅
callback	The URI callback that will handle the result.	'mycallbackscheme://result'	✅
action	Action set mode which change the operation of the app.	'setMode'	✅
mode	Set the selected operation. 0 = Attended, 1 = Semi-Unattended 2 = Full-Unattended, 3 = ECR-Controlled	'mode=0'	✅
pin	Pin (4-6 digits length) parameter is used to lock the severe actions in app Settings - Refund - Capture Card - History transaction. ⚠️The pin is mandatory.	'pin=252856'	✅		Min. length = 4 Max. length = 6	integer (int32)
cashless	Support of cash devices. The default value is true.	'cashless=true'		Supported only on IM30 devices.		boolean

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

Intent payIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(
                        "vivapayclient://pay/v1"
                                + "?appId=com.example.myapp"
                                + "&action=setMode"
                                + "&mode=1"
                                + "&pin=123456"
                                + "&callback=mycallbackscheme://result"));

payIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
startActivity(payIntent);

Set Mode response

After executing the Set Mode action the app will return the response to indicate if the app operate in unattended mode successful or not.

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

Uri result = getIntent().getData();

The table below summarizes 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 set mode.	'status=success'
message	A string containing information about the set mode status. The message indicate successful set it or not or the pin is not saved.	'message=Set mode successfully 1' or 'message=Pin not saved successfully'
action	Action set mode which change the operation of the app.	'action=setMode'

A Set Mode response result for the success is :

It is expected that POS activation will fail for various reasons. A POS activation response looks as follows:

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!