GratuityAmount Property

Gratuity amount for restaurant industry transactions.

Syntax

 ptechretail.getGratuityAmount([callback])
 ptechretail.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 contains the gratuity (tip) amount of the transaction. This property may be set in the PTechCharge class if you know the amount of the tip before the authorization. Otherwise, you may update the GratuityAmount property of the PTechDetailRecord class after parsing the detail aggregate returned from this class's GetDetailAggregate method. This amount is only sent when the PTechManualSettle class's IndustryType is set to "itRestaurant". If a transaction includes a GratuityAmount, the SettlementAmount must reflect the total of the originally authorized amount, plus the GratuityAmount.

This must be formatted as a dollar amount with a real decimal point, excluding the dollar sign. For instance "12.00"

Data Type

String