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 POS 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

For a typical Reset 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' Viva Wallet POS app for Android
merchantKey The merchant's key. For successful validation, should not be empty.
Deprecated: you may pass any value.
'SG23323424EXS3' Viva Wallet POS app for Android
appId The client app ID. For successful validation, should not be empty. 'com.example.myapp' Viva Wallet POS app for Android
action Reset action. For successful validation, should not be empty. 'reset' Viva Wallet POS app for Android
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
  • 'reset' Viva Wallet POS app for Android
    callback The URI callback that will handle the result. For successful validation, should not be empty. 'mycallbackscheme://result' Viva Wallet POS app for Android

    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 Card Terminal App 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' Viva Wallet POS app for Android
    status The status of the request. 'success' Viva Wallet POS app for Android
    message A string containing information about the request status. 'Full reset successfully completed!' Viva Wallet POS app for Android
    action Reset action. 'reset' Viva Wallet POS app for Android

    A Reset 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. Android Card Terminals
    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. Android Card Terminals
    Linux Card Terminals Countertop, IM20, S900, S800, D200. Linux Card Terminals

    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 Get Support page to see how we can help!