Cancel request

An overview of the Cancel request message for Android.

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

Overview

👉 The Cancel request is used to Cancel (void) a payment which occurred within the current business day (until 22:00 GMT+2) or to refund a successful payment - either partial or full - which occurred prior to the current business day (i.e. after the clearance process has taken place¹)

¹ Note: the clearance process also takes place on weekends and holidays

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.

• Cancel request originating from the client app to initiate a request for a Cancel transaction.
• Cancel response originating from the card terminal app to return the result of a Cancel transaction.

Cancel request

For a typical Cancel 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.	'cancel'	✅
referenceNumber	The STAN number of the transaction to be cancelled. If empty, after card presentment, the app will provide a list of the last 3 transactions made with the presented card, allowing the user to select the transaction to be canceled. If action is cancel and if not empty should be integer bigger than zero.	'123789'	Please note the following options (if using the Viva Wallet POS app for Android): - Pass one or more of the identification parameters (referenceNumber, orderCode, shortOrderCode), but no date parameters: this will allow the cancellation to be completed directly - Pass both of the date parameters (txnDateFrom & txnDateTo), but no identification parameters: this will allow the POS user to locate the desired transaction with filters (with the date range pre-filled but amendable), or to prompt the customer to present their card - Pass neither the identification parameters or the date parameters: this will allow the POS user to locate the desired transaction with filters (with the date range not pre-filled), or to prompt the customer to present their card
orderCode	If not empty should be integer bigger than zero and length 16.	'1020304050607080'
shortOrderCode	If not empty should be integer bigger than zero and length 10.	'1234567890'
txnDateFrom	If action is cancel and if not empty should be in "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" format.	'2021-03-18T14:42:53.341Z'
txnDateTo	If action is cancel and if not empty should be in "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'" format, txnDateFrom should be provided and txnDateTo should be after txnDateFrom.	'2021-03-19T14:42:53.341Z'
amount	The amount to refund in cents, without any decimal digits. If no amount provided, a full refund will be performed.	'100' = 1 euro (optional)
show_receipt	A flag indicating if the receipt and transaction result will be shown. If true both transaction result and receipt will be shown. If false receipt will not be shown and result will be shown if show_transaction_result is true.	'true'
show_transaction_result	A flag indicating if transaction result will be shown.	'true'
show_rating	A flag indicating if the rating flow will be shown.	'true'
callback	The URI callback that will handle the result. For successful validation, should not be empty.	'mycallbackscheme://result'	✅
protocol	The protocol used.	Always pass this value: int_default	Required for Paydroid devices

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=cancel"
                + "&referenceNumber=123456"
                + "&callback=mycallbackscheme://result"
                + "&orderCode=1020304050607080"
                + "&shortOrderCode=1234567890"
                + "&txnDateFrom=2021-03-18T14:42:53.341Z"
                + "&txnDateTo=2021-03-19T14:42:53.341Z"
                + "&amount=100"
                + "&show_receipt="+true
                + "&show_transaction_result="+true
                + "&show_rating="+true ));

payIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
//        Those two flags should be added for paydroid implementations
//        payIntent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TASK);
//        payIntent.addFlags(Intent.FLAG_ACTIVITY_NO_HISTORY);
                startActivity(payIntent);

Cancel response

After executing a cancel transaction, or refund, the card terminal app responds with a cancel response result to indicate if the refund has been approved or not.

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	Cancel transaction.	'cancel'
amount	The amount in cents without any decimal digits.	'1200' = 12 euro
cardType	The card type.	'VISA'
accountNumber	The card number. Note that only the 6 first and the 4 last digits are provided. All other digits are masked with stars.	'479275\*\*\*\*\*\*9999'
tid	A 12-character string indicating the terminal's TID number.	'16016684'
orderCode	16-digit integer.	'1020304050607080'
shortOrderCode	10-digit integer.	'1234567890'
transactionDate	The transaction date in ISO 8601 format.	'2019-09-13T12:14:19.8703452+03:00'
transactionId	A unique identifier for the transaction.	'a78e045c-49c3-4743-9071-f1e0ed71810c'
aid	A string indicating the AID of the card. (Used in successful receipts)	'A000000003101001'
vatNumber	The VAT number of merchant. (if print VAT is enabled in the Viva POS app settings) (Used in successful and declined receipts)	'123412341'
address	The address of merchant (if print address is enabled in the Viva POS app settings) (Used in successful receipts)	‘Main St 123, 12312 Anytown’
businessDescription	Merchant’s Business/Trade/Store name (depending on what option is selected in the Viva POS app settings), (Used in successful receipts)	'Wonka Industries'
printLogoOnMerchantReceipt	A boolean indicating weather the VivaWallet logo should be printed on merchant receipt. (Used in successful receipts)	'false'
merchantReceiptPAN	This field contains the value of the PAN (and additional clipping) that should be printed in merchant receipt. If is empty, then apply the default clipping. (Used in successful receipts)	'629914XXXXXXXXX6770'
cardholderReceiptPAN	This field contains the value of the PAN (and additional clipping) that should be printed in customer receipt. If is empty, then apply the default clipping.	'629914XXXXXXXXX6770'
transactionReceiptAcquirerZone	If it is not empty then this value should be printed at the end of the customer receipt. (Used in successful receipts)	'qwerty123456'
cardholderReceiptText	If is not empty then this value should be printed at the end of the customer receipt. (Used in successful receipts)	'qwerty123456'
merchantReceiptText	If is not empty then this value should be printed at the end of the customer receipt. (Used in successful receipts)	'qwerty123456'
cardholderName	Name of the cardholder. (Used in successful receipts)	'JOHN DOE'
cardExpirationDate	Expiration date of the card (YYMM). (Used in successful receipts)	'2212'
cardholderNameExpirationDateFlags	Each char may be 0 (false) or 1 (true) and indicates if the cardholder name and the expiration date should be printed on the merchant/cardholder receipts) 1st char: if 1 then the Cardholder Name should be printed in the merchant's receipt. If 0, then it should not. 2nd char: if 1 then the Cardholder Name should be printed in the cardholder's receipt. If 0, then it should not. 3rd char: if 1 then the Expiration Date should be printed in the merchant's receipt. If 0, then it should not. 4rd char: if 1 then the Expiration Date should be printed in the cardholder's receipt. If 0, then it should not. (Used in successful receipts)	'1010'
needsSignature	A boolean indicating if the receipt needs a signature section. (Used in successful receipts)	false
addQRCode	A boolean indicating if the order code should be printed as a QR. (Used in successful receipts)	false
terminalSerialNumber	The serial number of the terminal. (Used in successful receipts)	“1234567891“
currency	The currency of the transaction. (Used in successful receipts)	“EUR“
errorText	Text to print on the receipt stating the error description and the error ccode. (Used in declined receipts)	“Transaction failed - Z-3“
rrn	The Retrieval Reference Number of the transaction RRN. (Used in successful and declined receipts)	'123456833121'
applicationVersion	The version off the application. (Used in declined receipts)	'v3.7.0(1956)'

A cancel response result for an approved refund looks as follows:

It is expected that certain transactions will fail for various reasons. A cancel response result for a failed refund looks as follows:

The structure of the message is the same as in the case of an approved refund.

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 Wallet POS app for Android	Mini Card Reader, Pocket Card Terminal connected via Bluetooth or USB to the Viva Wallet POS 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!