Sale Method

Submits a sale transaction for an Electronic Benefits (EBT) card.

Syntax

globalbenefit.sale([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

EBT sale transactions are similar to Debit card transactions in that they are real-time and require an EncryptedPIN and KSN. EBT cards are connected to either a Food Stamp account or a Cash Benefit account, or both. Like debit transactions, EBT transactions also must use track2 data read from the card's magnetic stripe - track1 data is not acceptable. Food stamp transactions MAY be manually keyed, but cash benefit transactions may NOT be manually keyed. The BenefitType property indicates whether the sale acts on a Food Stamp or Cash Benefit account.

This transaction is automatically added to the current open batch, and will be settled after the current batch is released with the GlobalBatchMgr class.

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. For example:

Swiped Cash Benefits transaction with cash back:

class.CardEntryDataSource = edsMagneticStripe
class.CardMagneticStripe = "9999999800002773=09121015432112345678"   
class.EncryptedPIN = "623F36B53CC18393"
class.KSN = "000000008F000021"
class.BenefitType = btCashBenefits
class.TransactionAmount = "25.00" '$20 purchase with $5 cash back  
class.CashBack = "5.00"
class.Sale

Manually-keyed Food Stamp transaction:

class.CardEntryDataSource = edsManuallyEntered 
class.CardNumber = "9999999800002773"   
class.CardExpYear = 12
class.CardExpMonth = 2015
class.EncryptedPIN = "623F36B53CC18393"
class.KSN = "000000008F000021"
class.BenefitType = btFoodStamps
class.TransactionAmount = "25.00"  'Cash back not supported for food stamps!
class.Sale