OnRetransfer Event



 
Fires when the payment device returns credit to the script device account.


Syntax

    SiteKiosk.Plugins("SiteCash").Devices("ScriptDevice").
    OnRetransfer = handler
    
Parameters
    amount Currency value that contains the amount which is returned.
Remarks
    If the defined function of this event returns true, existing credit will not be added to the script device account. If false is returned and the RetransferEnabled property is true, existing credit from the account of the SiteCash object will be added to the script device account.
    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 the payment device wants to return credit and allows this.

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

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

Back to top