Set Printing Settings

An overview of the Set Printing Settings message.

• Overview
• setPrintingSettingsRequest
• setPrintingSettingsResponse
• Get Support

Overview

Please see below for information on configuring the setPrintingSettingsRequest, as well as the expected setPrintingSettingsResponse.

• setPrintingSettingsRequest - originating from the application to initiate a request to set the print receipt options
• setPrintingSettingsResponse - originating from the card terminal to return the response of a set printing settings request

setPrintingSettingsRequest

For a typical request the client must provide the following information:

Field	Type	Length (chars)	Description	Example	Required	Card terminal support
msgLength	String	4	A 4-digit number padded with leading zeros indicating message length minus 4 (including any separators). The request will be rejected if the correct message length is not provided.	‘0063’
sessionId	String	6	A unique number to control integrity of session sequence.	‘002690’
msgType	String	3	‘600’	‘600’	✅
businessDescriptionIdentifier	String	variable up to 12	The business description identifier that will be printed on the receipt if it is enabled. For successful validation, should be one of the following values: 'businessName', 'tradeName', 'storeName'	'businessName'
showLogoOnMerchantReceipt	String	2	A flag indicating whether the logo will be printed on the receipt of the merchant: False = ‘00’, True = '10'	'00'
showVatOnMerchantReceipt	String	2	A flag indicating whether the vat number will be printed on the receipt of the merchant: False = ‘00’, True = '10'	'00'
printOrderCodeBarcode	String	2	A flag indicating whether the barcode will be printed on the receipt: False = ‘00’, True = '10'	'00'
businessDescriptionEnabled	String	2	A flag indicating whether the business description identifier will be printed on the receipt: False = ‘00’, True = '10'	'00'
printAddressOnReceipt	String	2	A flag indicating whether the address will be printed on the receipt: False = ‘00’, True = '10'	'00'
isMerchantReceiptEnabled	String	2	A flag indicating whether the receipt of the merchant will be printed: False = ‘00’, True = '10'	'00'
isCustomerReceiptEnabled	String	2	A flag indicating whether the receipt of the merchant will be printed: False = ‘00’, True = '10'	'00'

The above information elements must be joined into one single string using ‘|’ as a separator. i.e.

0063|002690|600|businessName|00|00|00|00|00|00|00

If the resulting string gets appropriately transmitted to the terminal, the terminal will respond with a setPrintingSettingsResponse message (600).

setPrintingSettingsResponse

In a setPrintingSettingsRequest the terminal responds with a setPrintingSettingstResponse to indicate if the transaction has been approved or not.

A setPrintingSettingsResponse for an approved transaction looks as follows:

0048|000015|610|IP|00|businessName|00|00|00|00|00|00

The table below summarises the contents of the response.

Field	Length (chars)	Description	Example	Card terminal support
msgLength	4	A 4-digit number padded with leading zeros indicating the length of the message that follows (including separators). Before considering the msgLength value, please make sure that you've decoded the terminal response with UTF-8..	'0129'
seqTxnId	6	A 6 digit number matching the value sent in seqTnxNum field of the preceding txReady message.	'000032'
msgTypeResp	3	'710'	'710'
respCode	2	Approval status. '00' indicates approval. All other values indicate failure codes. See failure code table at the end.	'00'
businessDescriptionIdentifier	variable up to 12	The business description identifier that will be printed on the receipt if it is enabled. For successful validation, should be one of the following values: 'businessName', 'tradeName', 'storeName'	'businessName'
showLogoOnMerchantReceipt	2	A flag indicating whether the logo will be printed on the receipt of the merchant.	‘00’
showVatOnMerchantReceipt	2	A flag indicating whether the vat number will be printed on the receipt of the merchant.	‘00’
printOrderCodeBarcode	2	A flag indicating whether the barcode will be printed on the receipt.	‘00’
businessDescriptionEnabled	2	A flag indicating whether the business description identifier will be printed on the receipt.	‘00’
printAddressOnReceipt	2	A flag indicating whether the address will be printed on the receipt.	‘00’
isMerchantReceiptEnabled	2	A flag indicating whether the receipt of the merchant will be printed.	‘00’
isCustomerReceiptEnabled	2	A flag indicating whether the receipt of the merchant will be printed.	‘00’

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!