BalanceInquiry Method

Retrieves the balance remaining on an EBT card.

Syntax

ptechbenefit.balanceInquiry([callback])

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 this 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

A BalanceInquiry transaction requests that the host return the quantity of funds remaining in the customer's EBT Card. This transaction is not added to the batch and cannot be settled by the PTechHostSettle class. No charge is made to the customer's EBT card.

The EBT card may be specified by either a CardMagneticStripe returned by a card reader, (Track2 only), or manually entered through the CardNumber. CardExpMonth, and CardExpYear.

The ResponseCode and ResponseText properties indicate whether this transaction was successful.

The ResponseAvailableBalance and/or ResponseLedgerBalance, properties will contain the card's current balance. Additional balance information may be returned in the ResponseBeginningBalance. If the BenefitType is "Cash Benefits" the ResponseCashAvailableBalance, ResponseCashBeginningBalance, and ResponseCashLedgerBalance may also contain information (these properties are not filled for the "Food Stamp" BenefitType).