OnCheckRetransfer Event



 
Fires when SiteKiosk checks if the payment device can return credit to the script device account.


Syntax

    SiteKiosk.Plugins("SiteCash").Devices("ScriptDevice").
    OnCheckRetransfer = handler
    
Parameters
    amount Currency value that contains the amount which can be returned.
Remarks
    The defined function of this event can tell SiteKiosk that returning credit is possible using the return command. If this function returns false or nothing, the RetransferEnabled property defines the possibility of returning credit.
    Use the CurrencyFormatter object for currency functionality.

    The object that caused the event can be referenced in the event function using "this".
Examples
    The following example shows an alert window when SiteKiosk checks if credit can be returned and returns that this is possible.

    <SCRIPT TYPE="text/javascript">
    window.external.InitScriptInterface();
    sdevice = SiteKiosk.Plugins("SiteCash").Devices("ScriptDevice");
    sdevice.OnCheckRetransfer = OnCheckRetransfer;
    function OnCheckRetransfer(amount)
    {
       alert(amount);
       return true;
    }
    </SCRIPT>
    

Applies to
    SiteKiosk v5.0 (and later versions).

Back to top