ResponseLedgerBalance Property

Current balance of the EBT card, not including pending authorizations.

Syntax

 ptechbenefit.getResponseLedgerBalance([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 getResponseLedgerBalance([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 setResponseLedgerBalance([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

Current balance of the EBT card, not including pending authorizations. The Ledger, or Current balance indicates the actual balance of the EBT card on a specific day, and does not reflect any holds or pending transactions that have not yet been settled. If no ResponseAvailableBalance was returned in the response, this ResponseLedgerBalance should be printed on the receipt instead (if neither are returned, print "Balance Unavailable").

This property is read-only.

Data Type

String