Pre-auth request

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

Overview

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

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.

If you wish to activate preAuth functionality in your terminals, please contact your Viva sales representative. Alternatively, you can contact us directly via our live chat facility, by simply clicking on the live chat icon in the bottom right-hand corner of this page.

Pre-auth request

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

Please note: ISV parameters are not included, as pre-authorizations are not supported for card-present payments using the ISV schema

Field Description Example Required Card terminal support Character limit Type
scheme The Viva custom URL scheme, the host and the version. 'vivapayclient://pay/v1' ✅ Android Card Terminals'viva.com | Terminal' application for Android
merchantKey The merchant's key. For successful validation, should not be empty.
Deprecated: you may pass any value.
'SG23323424EXS3' Android Card Terminals'viva.com | Terminal' application for Android
appId The client app ID. For successful validation, should not be empty. 'com.example.myapp' ✅ Android Card Terminals'viva.com | Terminal' application for Android
action Pre-auth transaction. For successful validation, should not be empty. 'pre_auth' ✅ Android Card Terminals'viva.com | Terminal' application for Android
clientTransactionId A unique transaction ID transmitted to the host for storage with the transaction. Note that this value will be provided in the Merchant Reference field provided in the sales export response. '12345678901234567890123456789012' Android Card Terminals'viva.com | Terminal' application for Android 2048
amount Amount in cents without any decimal digits. This value must not be empty and must be an integer larger than zero. '1200' = 12 euro ✅ Android Card Terminals'viva.com | Terminal' application for Android 2048 decimal
callback The URI callback that will handle the result. For successful validation, should not be empty. 'mycallbackscheme://result' ✅ Android Card Terminals'viva.com | Terminal' application for Android
show_receipt A flag indicating if the receipt and transaction result will be shown. If true both transaction result and receipt will be shown. If false receipt will not be shown and result will be shown if show_transaction_result is true. 'true' 'viva.com | Terminal' application for Android boolean
show_transaction_result A flag indicating whether transaction result will be shown. 'true' 'viva.com | Terminal' application for Android boolean
show_rating A flag indicating if the rating flow will be shown. 'true' 'viva.com | Terminal' application for Android boolean
aadeProviderId [*] Unique Number to identify specific Provider (ΥΠΑΗΕΣ):

  • VivaDemo - ‘999’
  • SoftOne - ‘101’
  • EnterSoft - ‘102’
  • Impact - ‘103’
  • Epsilon Net - ‘104’
  • Novus Conceptus - ‘105’
  • Cloud Services IKE - ‘106’
  • Primer Software - ‘107’
  • ILYDA = ‘108’
  • Prosvasis = ‘109’
  • MAT = ‘110’
  • Simply = ‘111’
  • Kappa = ‘112’
  • SBZ = ‘113’
  • OneSys = ‘114’
  • ORIAN = ‘115’
  • TESAE = ‘116’
  • Karpodinis = ‘117’
  • Cloud T = ‘118’
  • Πάροχος Λύσεων Πληροφορικής Α.Ε. = ‘119’
  • '999' Android Card Terminals'viva.com | Terminal' application for Android 3 Numeric
    aadeProviderSignatureData [*] The unencrypted signature that includes the fields below with semicolon as a delimiter “;”:

  • Receipt UID
  • MARK (Unique ID provided by AADE - commonly null as this provider after the end of the transaction)
  • Date and time of the Signature
  • Amount to be paid
  • Sum Amount without TAX
  • VAT percentage
  • Sum Amount with TAX
  • TID
  • AD33729F4ED749928AAFA00B90EE4EA91551BAC1;;20231204080313;1051;10000;2400;12400;POS_1 Android Card Terminals'viva.com | Terminal' application for Android 200 Alphanumeric
    aadeProviderSignature [*] The fields of providerSignatureFields encrypted using a public key and the Elliptic Curve Digital Signature Algorithm (ECDSA):

  • Algorithm: ECDSA
  • Curve: NISTP256
  • HASH: SHA256
  • The signature is sent to POS in base64 format
  • o0094r3Yk3KTqASLkW3evlDsnIg/ZAdUUf6UCXDtjqpI/dquzAT4WNX3yzS/GLciVNbT75H4pj8hLOV0EpHtzw==" Android Card Terminals'viva.com | Terminal' application for Android

    [*] These parameters are only applicable in Greece

    The above parameters must be used to create a URI call. Please see the below example:

    Intent payIntent = new Intent(Intent.ACTION_VIEW, Uri.parse(
                            "vivapayclient://pay/v1"
                                    + "?merchantKey="MY_MERCHANT_KEY""
                                    + "&appId=com.example.myapp"
                                    + "&action=pre_auth"
                                    + "&clientTransactionId=1234567801234"
                                    + "&amount=1200"
                                    + "&show_receipt="+true
                                    + "&show_transaction_result="+true
                                    + "&show_rating="+true
                                    + "&aadeProviderId=999"
                                    + "&aadeProviderSignatureData=AD33729F4ED749928AAFA00B90EE4EA91551BAC1;;20231204080313;1051;10000;2400;12400;POS_1"
                                    + "&aadeProviderSignature=o0094r3Yk3KTqASLkW3evlDsnIg/ZAdUUf6UCXDtjqpI/dquzAT4WNX3yzS/GLciVNbT75H4pj8hLOV0EpHtzw=="
                                    + "&callback=mycallbackscheme://result"));
    
    payIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
    
    payIntent.addFlags(Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS);
                    startActivity(payIntent);

    Pre-auth response

    After executing a Pre-auth transaction the ‘viva.com | Terminal’ application responds with a Pre-auth response result to indicate if the transaction has been approved 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' Android Card Terminals'viva.com | Terminal' application for Android
    status The status of the transaction. 'success' Android Card Terminals'viva.com | Terminal' application for Android
    message A string containing information about the transaction status. 'Transaction successful' Android Card Terminals'viva.com | Terminal' application for Android
    action Pre-auth transaction. 'pre_auth' Android Card Terminals'viva.com | Terminal' application for Android
    clientTransactionId The client transaction ID. '12345678901234567890123456789012' Android Card Terminals'viva.com | Terminal' application for Android
    amount The amount in cents without any decimal digits. If action is cancel and amount is not empty must be integer and bigger than zero.
    (Used in successful and declined receipts)
    '1200' = 12 euro Android Card Terminals'viva.com | Terminal' application for Android
    verificationMethod The verification method used. 'CHIP-PIN' Android Card Terminals'viva.com | Terminal' application for Android
    rrn The Retrieval Reference Number of the transaction RRN.
    (Used in successful and declined receipts)
    '123456833121' Android Card Terminals'viva.com | Terminal' application for Android
    cardType The card type. 'VISA' Android Card Terminals'viva.com | Terminal' application for Android
    accountNumber The card number masked. Note that only the 6 first and the 4 last digits are provided. All other digits are masked with stars.
    (Used in successful and declined receipts)
    '479275\*\*\*\*\*\*9999' Android Card Terminals'viva.com | Terminal' application for Android
    referenceNumber A 6-digit number indicating the transaction's STAN number. '833121' Android Card Terminals'viva.com | Terminal' application for Android
    authorisationCode A 6-digit number indicating the transaction's Authorisation code provided by the host. '690882' Android Card Terminals'viva.com | Terminal' application for Android
    tid A 12 character string indicating the terminal's TID number. ' 16016684' Android Card Terminals'viva.com | Terminal' application for Android
    orderCode The order code. ' 9256110059000200' Android Card Terminals'viva.com | Terminal' application for Android
    shortOrderCode 10-digit integer. '1234567890' Android Card Terminals'viva.com | Terminal' application for Android
    transactionDate The transaction date in ISO 8601 format.
    (Used in successful and declined receipts)
    '2019-09-13T12:14:19.8703452+03:00' Android Card Terminals'viva.com | Terminal' application for Android
    transactionId A unique identifier for the transaction. 'a78e045c-49c3-4743-9071-f1e0ed71810c' Android Card Terminals'viva.com | Terminal' application for Android
    aid A string indicating the AID of the card.
    (Used in successful receipts)
    'A000000003101001' Android Card Terminals'viva.com | Terminal' application for Android
    vatNumber The VAT number of merchant.
    (if print VAT is enabled in the 'viva.com | Terminal' application settings)
    (Used in successful and declined receipts)
    '123412341' Android Card Terminals'viva.com | Terminal' application for Android
    address The address of merchant
    (if print address is enabled in the 'viva.com | Terminal' application settings)
    (Used in successful receipts)
    ‘Main St 123, 12312 Anytown’ Android Card Terminals'viva.com | Terminal' application for Android
    businessDescription Merchant’s Business/Trade/Store name (depending on what option is selected in the 'viva.com | Terminal' application settings),
    (Used in successful receipts)
    'Wonka Industries' Android Card Terminals'viva.com | Terminal' application for Android
    printLogoOnMerchantReceipt A boolean indicating weather the VivaWallet logo should be printed on merchant receipt.
    (Used in successful receipts)
    'false' Android Card Terminals'viva.com | Terminal' application for Android
    merchantReceiptPAN This field contains the value of the PAN (and additional clipping) that should be printed in merchant receipt. If is empty, then apply the default clipping.
    (Used in successful receipts)
    '629914XXXXXXXXX6770' Android Card Terminals'viva.com | Terminal' application for Android
    cardholderReceiptPAN This field contains the value of the PAN (and additional clipping) that should be printed in customer receipt. If is empty, then apply the default clipping. '629914XXXXXXXXX6770' Android Card Terminals'viva.com | Terminal' application for Android
    transactionReceiptAcquirerZone If it is not empty then this value should be printed at the end of the customer receipt.
    (Used in successful receipts)
    'qwerty123456' Android Card Terminals'viva.com | Terminal' application for Android
    cardholderReceiptText If is not empty then this value should be printed at the end of the customer receipt.
    (Used in successful receipts)
    'qwerty123456' Android Card Terminals'viva.com | Terminal' application for Android
    merchantReceiptText If is not empty then this value should be printed at the end of the customer receipt.
    (Used in successful receipts)
    'qwerty123456' Android Card Terminals'viva.com | Terminal' application for Android
    cardholderName Name of the cardholder.
    (Used in successful receipts)
    'JOHN DOE' Android Card Terminals'viva.com | Terminal' application for Android
    cardExpirationDate Expiration date of the card (YYMM).
    (Used in successful receipts)
    '2212' Android Card Terminals'viva.com | Terminal' application for Android
    cardholderNameExpirationDateFlags Each char may be 0 (false) or 1 (true) and indicates if the cardholder name and the expiration date should be printed on the merchant/cardholder receipts)

    1st char: if 1 then the Cardholder Name should be printed in the merchant's receipt. If 0, then it should not.

    2nd char: if 1 then the Cardholder Name should be printed in the cardholder's receipt. If 0, then it should not.

    3rd char: if 1 then the Expiration Date should be printed in the merchant's receipt. If 0, then it should not.

    4rd char: if 1 then the Expiration Date should be printed in the cardholder's receipt. If 0, then it should not.
    (Used in successful receipts)
    '1010' Android Card Terminals'viva.com | Terminal' application for Android
    needsSignature A boolean indicating if the receipt needs a signature section.
    (Used in successful receipts)
    false Android Card Terminals'viva.com | Terminal' application for Android
    addQRCode A boolean indicating if the order code should be printed as a QR.
    (Used in successful receipts)
    false Android Card Terminals'viva.com | Terminal' application for Android
    terminalSerialNumber The serial number of the terminal.
    (Used in successful receipts)
    “1234567891“ Android Card Terminals'viva.com | Terminal' application for Android
    currency The currency of the transaction.
    (Used in successful receipts)
    “EUR“ Android Card Terminals'viva.com | Terminal' application for Android
    errorText Text to print on the receipt stating the error description and the error ccode.
    (Used in declined receipts)
    “Transaction failed - Z-3“ Android Card Terminals'viva.com | Terminal' application for Android
    applicationVersion The version off the application.
    (Used in declined receipts)
    'v3.7.0(1956)' Android Card Terminals'viva.com | Terminal' application for Android
    oldBalance The old balance of the cardholder.
    (Used in successful receipts)
    '200' = 2 euro Android Card Terminals'viva.com | Terminal' application for Android
    newBalance The new balance of the cardholder.
    (Used in successful receipts)
    '200' = 2 euro Android Card Terminals'viva.com | Terminal' application for Android
    entryMode The POS entry mode.
    (Used in successful receipts)
    '07' Android Card Terminals'viva.com | Terminal' application for Android
    aadeTransactionId An AADE-specific transaction ID.

    Format: Acquirer Unique code + RRN + Authorization code.

    Example: ‘116’ + ‘123456833121’ + ‘690882’ = '116123456833121690882'
    '116123456833121690882' Android Card Terminals'viva.com | Terminal' application for Android

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

    A sale response for a successful pre-auth transaction using AADE parameters 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.com | Terminal' application for Android Mini Card Reader, Pocket Card Terminal connected via Bluetooth or USB to the 'viva.com | Terminal' application 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, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!