Navigation:
AADE Protocol
Native Checkout v2
About Viva
Getting started
Payment methods
Integration reference
Plugins
Smart Checkout
Marketplaces
Marketplaces - OLD
Payment tools
ISV Partner program
APIs for payments
Webhooks for payments
Tutorials
Code samples for payments
Issuing
APIs for APM provisioning
In-person payments
-
Softpos Apps
--
Tap on Any Device on Android
---
Sale request
---
Pre-auth request
---
Capture Pre-auth request
---
Cancel/Refund request
---
Rebate request
---
Fast Refund request
---
Unreferenced Refund
---
Abort request
---
Batch request
---
Reprint request
--- Set Mode request
---
Transaction Details request
--- P2P Protocol Activation
---
Foreground request
---
Set Printing Settings request
---
Get Printing Settings request
---
Send Logs request
---
POS Activation request
---
Get Activation Code request
---
Decimal Amount Mode request
---
Reset request
--
Tap on Any Device on iOS
-
Payment Terminal API
- Dynamic Currency Conversion
- Enable/Disable Multi-merchant
- Surcharge
- Dynamic Descriptor
- Enable/Disable Instalments & Tips
- Rebate and Fast Refund
- Card Present Tokenization
- Mail Order/Telephone Order (MOTO)MOTO payments
- Sample Receipts
-
SDKs
Client case studies
Release Notes
Contact & Support
Fiscalisation
Reset request
An overview of the Reset request message for Android.
Overview
👉 The Reset request is used to perform either a soft or full reset of the ‘Viva.com Terminal’ application.
The two types of reset (‘soft’ and ‘full’) differ as follows:
A ‘soft’ reset (or ‘settings’ reset) will reset the app settings to their defaults without erasing your previously entered account information
A ‘full’ Reset will reset the app settings to their defaults, erasing your previously entered account information
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.
Reset request originating from client app to reset the ‘Viva.com Terminal’ application.
Reset response originating from ‘Viva.com Terminal’ application to return the result of the Reset request.
Reset request
For a typical Reset request, the client app must provide the following information:
Field
Description
Example
Required
Card terminal support
Character limit
Type
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
Reset action. For successful validation, should not be empty.
'reset'
✅
softReset
A flag indicating whether the application will make a soft or a full reset.
If value is false
, a full reset will be made
If value is true
, a soft reset will be made
If parameter is excluded or blank, a soft reset will be made
'false'
Boolean
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=reset"
+ "&softReset=true"
+ "&callback=mycallbackscheme://result" ));
payIntent . addFlags ( Intent . FLAG_ACTIVITY_NEW_TASK );
payIntent . addFlags ( Intent . FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS );
startActivity ( payIntent );
Reset response
After executing a Reset request, the ‘Viva.com Terminal’ application responds with a response result to indicate if the Reset request has been successful 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 request.
'success'
message
A string containing information about the request status.
'Full reset successfully completed!'
action
Reset action.
'reset'
A Reset response result looks as follows:
mycallbackscheme://result?action=reset&message=Full reset successfully completed!&status=success`
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!