CashOutIndicator Property

Indicates to the host that the customer wants the remainder of the card's value returned as cash.

Syntax

 ptechgiftcard.getCashOutIndicator([callback])
 ptechgiftcard.setCashOutIndicator( cashOutIndicator, [callback])

Default Value

FALSE

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 getCashOutIndicator([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 setCashOutIndicator([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

When the CashOutIndicator is set to True, the stored value card will be "cashed out". This means that all funds stored on the card is cleared, and the merchant is to return those funds to the customer as cash. Thus, when CashOutIndicator is True the ResponseCashOut property will contain the amount of money the merchant is to return to the customer in cash. The ResponseAuthorizedAmount property will contain the total amount removed from the gift card (The sum of the TransactionAmount plus the ResponseCashOut amount).

Data Type

Boolean