Send Logs request

An overview of the Send Logs request message for Android.

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

Overview

👉 The Send Logs request is used to send the logs of the ‘viva.com | Terminal’ application to the Viva payment platform. This is particularly useful for troubleshooting purposes.

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.

• Send Logs request originating from the client app to trigger the application to upload logs
• Send Logs response originating from the ‘viva.com | Terminal’ application to return the result of a Send Logs request

Send Logs request

For a typical Send Logs request, the client app must provide the following information:

Field	Description	Example	Required	Card terminal support
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	Cancel transaction. For successful validation, should not be empty.	'sendLogs'	✅
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=sendLogs"
			+ "&callback=mycallbackscheme://result"));


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

Send Logs response

After executing an abort transaction, the ‘viva.com | Terminal’ application responds with an abort response result to indicate if the abort request has been successful or not. It should be noted that the response from the abort action is actually the response of a failed transaction.

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

Uri result = getIntent().getData();

The table below summarizes the contents of a successful 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.	'Send Logs completed'
action	Cancel transaction.	'sendLogs'

A send logs response result 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!