POS Activation request

An overview of the POS Activation request message for iOS.

• Overview
• POS Activation request
• POS Activation response
  • Error codes
• Get Support

Overview

👉 The POS Activation request is used to complete the activation process of the Viva POS App, including sign-in and initial configuration.

The client app must implement a mechanism to send messages using URL schemes and to receive the result in a custom URI callback.

• POS Activation request originating from the client app to trigger the Viva.com Terminal App activation.
• POS Activation response originating from the ‘Viva.com Terminal’ application to return the result of the Viva.com Terminal App activation request.

POS Activation request

For a typical POS Activation request, the client app must provide the following information:

The above information elements must create a URI call, i.e.

// USE LIKE THIS
    func activatePos() {
                let url =  "vivapayclient://pay/v1"
                                    + "?appId=com.example.myapp"
                                    + "&action=activatePos"
                                    + "&apikey=xxxxx.apps.vivapayments.com"
                                    + "&apiSecret=qtFskX94T2f2Dkhc364pa1cgaFn3D"
                                    + "&sourceID=1234"
                                    + "&pinCode=9876"
                                    + "&activateMoto=true"
                                    + "&activateQRCodes=true"
                                    + "&disableManualAmountEntry=true"
                                    + "&forceCardPresentmentForRefund=true"
                                    + "&lockRefund=true"
                                    + "&lockTransactionsList=true"
                                    + "&lockMoto=true"
                                    + "&lockPreauth=true"
                                    + "&callback=mycallbackscheme://result"

         (UIApplication.shared.delegate as? AppDelegate)?.performInterAppRequest(
            request: url)
    }

POS Activation response

After executing a POS activation, the ‘Viva.com Terminal’ application 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 application(_:open:options:) method on the AppDelegate file:

The table below summarizes the contents of an approved response.

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

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

Error codes

The following error codes may be displayed in the response to this request.

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!