Pre-auth request

An overview of the Pre-auth request message for iOS.

• Overview
• Pre-auth request
• Pre-auth response
• Get Support

Overview

👉 The Pre-auth request is used to initiate a pre-authorisation transaction.

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

• Pre-auth request originating from the client app to initiate a request for a new Pre-auth transaction.
• Pre-auth response originating from the Viva POS App to return the result of a Pre-auth transaction.

Pre-auth request 

For a typical Pre-auth request, the client app must provide the following information:

[*] These parameters are only applicable in Greece.

The above information elements must create a URI call, such as:

func createPreauthRequest(
    amount: Decimal
) -> String {
    // construct sale action url
    var preauthActionURL = Constants.preauthUrlString  // vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=pre-auth

    preauthActionURL += "&amount=\(((amount * 100) as NSDecimalNumber).intValue)"  // The amount in cents without any decimal digits.

    // append clientTransactionId parameter (if any)
    if let transactionId = clientTransactionId, transactionId != "" {
        preauthActionURL += "&clientTransactionId=\(transactionId)"
    }

    let showReceipt = UserDefaults.standard.value(forKey: "show_receipt") as? Bool ?? true
    preauthActionURL += "&show_receipt=\(showReceipt)"

    let showRating = UserDefaults.standard.value(forKey: "show_rating") as? Bool ?? true
    preauthActionURL += "&show_rating=\(showRating)"

    let showResult =
        UserDefaults.standard.value(forKey: "show_transaction_result") as? Bool ?? true
    preauthActionURL += "&show_transaction_result=\(showResult)"

    return preauthActionURL
}

Request example

Request sample:vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=pre_auth&amount=1200&show_receipt=false&show_rating=true

Pre-auth response

After executing a Pre-auth transaction, the ‘Viva.com Terminal’ application responds with a result to indicate if the transaction has been approved or not.

The result is received as a URI in the callback activity.

The table below summarises the contents of an approved response.

Examples

A Pre-auth response result for an approved transaction looks as follows:

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!