bool Void (string, string, int, int, string, string, string, string)

Voids an unconfirmed PreAuth transaction and returns the result via the OnKioEMVTransactionCompleted callback.

Security

Trust Level Required: Full Trust

Parameters

Name Description
transactionRefId string
The corresponding payment transaction ReferenceID from the OnKioEMVTransactionCompleted callback.
deviceName (Optional) string
The name of the device. If not supplied, the first matching configured device of this type will be used.
paymentAmount (Optional) int
The amount of the transaction to confirm in cents, or whatever the minor currency unit is for your device/configuration.
taxAmount (Optional) int
The amount of tax to confirm in cents, or whatever the minor currency unit is for your device/configuration.
cardToken (Optional) string
Card token returned by the preceeding Authorization request.
authCode (Optional) string
Auth code returned by the preceeding Authorization request.
AcqRefData (Optional) string
The acquirer reference data, sometimes needed for running a refund operation.
ProcessData (Optional) string
The processor data, sometimes needed for running a refund operation.

Return

True if the command was queued for processing, false otherwise.

Remarks

After successfully running a PreAuth transaction, the transaction must then be confirmed or voided. This call effectively cancels the submitted PreAuth transaction. The call must be made while the PreAuth transaction is still in the day's batch. This transaction type is not supported by NETePay. This call should not be used to void sale transactions; VoidSale() should be called instead.

Examples


if (!KioEMVTransaction.Payment('425'))
   alert('Failed to call Payment!');

var TransTypes = {
    None: 0,
    SetParameters: 1,
    Payment: 2,  // PreAuth
    Confirm: 3,  // PreAuth Capture
    Terminate: 4,
    VoidTrans: 5,
    Refund: 6,
    SetIdleMsg: 7,
    Sale: 8,
    VoidSale: 9,
    Reset: 10,
    RequestTMSUpdate: 11,
}

var ResultTypes = {
    Unknown: 0,
    Approved: 1,
    Declined: 2,
    Error: 3,
}

                                // callback fired when operation processed
function OnKioEMVTransactionCompleted(result) {
   alert('Operation returned: ' + lastTransResult.Result);
   if (lastTransResult.Result == ResultTypes.Approved) {
      if ((lastTransResult.TransType == TransTypes.Payment) {
         KioEMVTransaction.Void(lastTransResult.ReferenceID);
                                    }
                                  }
}

Requirements

KioWare for Windows version 8.7 or greater.