Capture Pre-auth request

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

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

Overview

👉 The Capture Pre-auth request is used to capture 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.

• Capture Pre-auth request originating from the client app to initiate a request for a Capture Pre-auth transaction.
• Capture Pre-auth response originating from the Viva.com | Terminal App to return the result of a Capture Pre-auth transaction.

Capture Pre-auth request

For a typical Capture 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 createCapturePreauthRequest(captureAmount: Decimal?, reference: String?, orderCode: String?, shortOrderCode: String?, dateFrom: String?, dateTo: String?) -> String {

        // construct capture action url
        var capturePreauthActionURL = Constants.captureUrlString // vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=capture_pre_auth

        if let amount = refundAmount {
            capturePreauthActionURL += "&amount=\(((amount * 100) as NSDecimalNumber).intValue)" // The amount in cents without any decimal digits.
        }

        if let unwrappedReference = reference, unwrappedReference != "" {
            capturePreauthActionURL += "&referenceNumber=\(unwrappedReference)" // transaction reference number
        }

        if let unwrappedOrderCode = orderCode, unwrappedOrderCode != ""  {
            capturePreauthActionURL += "&orderCode=\(unwrappedOrderCode)" // transaction order code
        }

        if let unwrappedShortOrderCode = shortOrderCode, unwrappedShortOrderCode != ""  {
            capturePreauthActionURL += "&shortOrderCode=\(unwrappedShortOrderCode)" // transaction short Order Code
        }

        if let dateFrom = dateFrom {
            capturePreauthActionURL += "&txnDateFrom=\(dateFrom)"
        }

        if let dateTo = dateTo {
            capturePreauthActionURL += "&txnDateTo=\(dateTo)"
        }

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

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

        return capturePreauthActionURL
    }
    //USE LIKE THIS
        let capturePreauthActionURL: String = createCapturePreauthRequest(captureAmount: 5, reference: nil, orderCode: nil, shortOrderCode: "1091139195",, dateFrom: "2021-03-29T00:00:00.000+0300", dateTo: nil)
        (UIApplication.shared.delegate as? AppDelegate)?.performInterAppRequest(request: capturePreauthActionURL)

Request example

Request sample:vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=capture_pre_auth&amount=600&shortOrderCode=1091139195&txnDateFrom=2021-03-29T00:00:00.000+0300&show_receipt=false

Request sample for merchants registered in Greece(including AADE parameters):vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=capture_pre_auth&amount=600&shortOrderCode=1091139195&txnDateFrom=2021-03-29T00:00:00.000+0300&show_receipt=false&aadeProviderId=999&aadeProviderSignatureData=AD33729F4ED749928AAFA00B90EE4EA91551BAC1;;20231204080313;1051;10000;2400;12400;POS_1&aadeProviderSignature=o0094r3Yk3KTqASLkW3evlDsnIg/ZAdUUf6UCXDtjqpI/dquzAT4WNX3yzS/GLciVNbT75H4pj8hLOV0EpHtzw==

Capture Pre-auth response

After executing a Capture 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 Capture Pre-auth response result for an approved transaction looks as follows:

A Capture Pre-auth response result for an approved transaction using AADE parameters looks as follows:

It is expected that certain transactions will fail for various reasons. A Capture Pre-auth response result for a failed transaction looks as follows:

The structure of the message is the same as in the case of an approved transaction.

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!