POS Activation

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.

POS Activation request

With the POS Activation action the user can activate the POS. For a typical POS activation request the client app must provide the following information:

Field Description Example Card terminal support
scheme The Viva's custom URL scheme, the host and the version. 'vivapayclient://pay/v1' 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 Activate POS action. For successful validation, should not be empty. 'activatePos' 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
apikey The API key required for the POS activation. For successful validation, should not be empty. “qwerty123456“ Viva Wallet POS app for Android
apiSecret The API secret required for the POS activation. For successful validation, should not be empty. “qwerty123456“ Viva Wallet POS app for Android
sourceID The source that POS will be assigned to. Not required for succesfull validation. If not provided “Default” source will be used “qwerty123456“ Viva Wallet POS app for Android
pinCode Optional parameter (4-6 digits length) for PIN code for settings lock (if provided, settings are automatically locked and PIN set to the supplied value) 123142 Viva Wallet POS app for Android
skipExternalDeviceSetup Optional boolean parameter. Skip external device configuration (Mini card reader or Pocket Card terminal) and proceed with **NFC payment method** for transactions. The default value = true

Example: true
Viva Wallet POS app for Android
activateMoto Optional boolean parameter for activating Moto payment method. The default value = false

Example: false
Viva Wallet POS app for Android
activateQRCodes Optional boolean parameter for activating QR payment method. The default value = false

Example: false
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"
                                + "&appId=com.example.myapp"
                                + "&action=activatePos"
                                + "&apikey=qwerty123456"
                                + "&apiSecret=qwerty123456"
                                + "&sourceID=qwerty123456"
                                + "&pinCode=123142"
                                + "&skipExternalDeviceSetup=true"
                                + "&activateMoto=true"
                                + "&activateQRCodes=true"
                                + "&callback=mycallbackscheme://result"));

payIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
startActivity(payIntent);

POS Activation response

After executing a POS activation, the Card Terminal App responds with a POS activation response result to indicate if the POS activation was successfull or not.

The result is received as a URI in the callback activity intent:

Uri result = getIntent().getData();

The table below summarizes 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 transaction. 'success' Viva Wallet POS app for Android
message A string containing information about the transaction status. 'Transaction successful' Viva Wallet POS app for Android
action Activate POS action. 'activatePos' Viva Wallet POS app for Android
virtualId App FirebaseId '60DEC5165EBC41DEAAE693FD51B1F3FC' Viva Wallet POS app for Android
sourceTerminalId Optional parameter - Connected Terminal Id. 16027706 Viva Wallet POS app for Android
merchantID Optional parameter - Activated Merchant Id. `c21ac4b3-b1e1-4e7c-a65e-aedee7412321` Viva Wallet POS app for Android

A POS activation response result for an approved transaction looks as follows:

It is expected that POS activation will fail for various reasons. A POS activation response looks as follows:

Get Support

If you have any questions about our solutions, or questions about how to integrate with our solutions, please refer to our Get Support page.