GratuityAmount Property
The gratuity (tip) amount of the transaction.
Syntax
tsyshcretail.getGratuityAmount([callback]) tsyshcretail.setGratuityAmount( gratuityAmount, [callback])
Default Value
""
Callback
The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).
The callback for the getGratuityAmount([callback]) method is defined as:
function(err, data){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'data' is the value returned by the method.
The callback for the setGratuityAmount([callback]) method is defined as:
function(err){ }
'err' is the error that occurred. If there was no error, then 'err' is 'null'.
'err' has 2 properties which hold detailed information:
err.code err.message
Remarks
This property is used to specify the gratuity (tip) amount when performing an authorization via Authorize.
If you wish to later adjust a tip amount, AdjustTip can be used after the initial authorization has been performed.
Data Type
String