ResponseNetDeposit Property

Total of purchases minus credits and voids.

Syntax

 tsyssettle.getResponseNetDeposit([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 getResponseNetDeposit([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 setResponseNetDeposit([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

Total of purchases minus credits and voids.

This property contains the net deposit generated by the terminal. It should equal the BatchNetDesposit property, which is computed by the class. The net deposit total is generated by adding the settlement amounts of all detail transaction records and subtracting credit amounts from it. This property is represented as an absolute value and cannot be negative.

This amount is to be presented with an implied decimal point. For example, US $10.00 must be represented as 1000, and $0.10 is likewise simply 10. The allowable number of significant digits as well as the positioning of any implied decimal point is dictated by the designated CurrencyCode configuration setting. In the United States (default), the number of allowable significant digits is seven. Thus the maximum TransactionAmount is "9999999", yielding a US dollar amount of $99,999.99. This property may not contain a negative number.

This property is read-only and not available at design time.

Data Type

String