Get Printing Settings request

An overview of the Get Printing Settings request message for Android.

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

Overview

👉 The Get Printing Settings request is used to retrieve the current configuration of the printing-related settings of the ‘Viva.com Terminal’ application.

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.

• Get Printing Settings request originating from the client app to get the Printing Settings of the ‘Viva.com Terminal’ application.
• Get Printing Settings response originating from the ‘Viva.com Terminal’ application to return the result of the Get Printing settings request.

Get Printing Settings request

For a typical Get Printing Settings 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	Get printing settings. For successful validation, should not be empty.	'getPrintingSettings'	✅
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.

String reqStr = "vivapayclient://pay/v1"
		+ "?merchantKey="MY_MERCHANT_KEY"
		+ "&appId=com.example.myapp"
		+ "&action=getPrintingSettings"
		+ "&callback=mycallbackscheme://result";

Intent payIntent = new Intent(Intent.ACTION_VIEW, Uri.parse( reqStr));
payIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
startActivity(payIntent);

Get Printing Settings response

After executing the get printing settings request, the ‘Viva.com Terminal’ application responds with the details of printing settings.

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	Get printing settings.	'get the printing settings of the 'Viva.com Terminal' application from a third-party app'
businessDescriptionEnabled	A flag indicating whether the business description identifier will be printed on the receipt	'true'
businessDescriptionType	The business description identifier that will be printed on the receipt if it is enabled. It can be one of the following values: 'businessName', 'tradeName', 'storeName'	'businessName'
printLogoOnMerchantReceipt	A flag indicating whether the logo will be printed on the receipt of the merchant	'true'
printVATOnMerchantReceipt	A flag indicating whether the vat number will be printed on the receipt of the merchant	'true'
isBarcodeEnabled	A flag indicating whether the barcode will be printed on the receipt	'true'
printAddressOnReceipt	A flag indicating whether the address will be printed on the receipt	'true'
isMerchantReceiptEnabled	A flag indicating whether the receipt of the merchant will be printed	'true'
isCustomerReceiptEnabled	A flag indicating whether the receipt of the customer will be printed	'true'

A get printing settings 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!