FDMSOmahaRetail Class

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSOmahaRetail component is used to perform Credit, Debit, or EBT card transactions in a Retail environment, where the customer is purchasing products or services in person.

Class Name

InPayDirect_FDMSOmahaRetail

Procedural Interface

 inpaydirect_fdmsomaharetail_open();
 inpaydirect_fdmsomaharetail_close($res);
 inpaydirect_fdmsomaharetail_register_callback($res, $id, $function);
 inpaydirect_fdmsomaharetail_get_last_error($res);
 inpaydirect_fdmsomaharetail_get_last_error_code($res);
 inpaydirect_fdmsomaharetail_set($res, $id, $index, $value);
 inpaydirect_fdmsomaharetail_get($res, $id, $index);
 inpaydirect_fdmsomaharetail_do_authonly($res);
 inpaydirect_fdmsomaharetail_do_config($res, $configurationstring);
 inpaydirect_fdmsomaharetail_do_debitrefund($res);
 inpaydirect_fdmsomaharetail_do_debitvoidtransaction($res, $detailaggregate);
 inpaydirect_fdmsomaharetail_do_ebtbalanceinquiry($res);
 inpaydirect_fdmsomaharetail_do_ebtcashwithdrawal($res);
 inpaydirect_fdmsomaharetail_do_getdetailaggregate($res);
 inpaydirect_fdmsomaharetail_do_interrupt($res);
 inpaydirect_fdmsomaharetail_do_reset($res);
 inpaydirect_fdmsomaharetail_do_sale($res);

Remarks

This component allows for a connection to the FDMS FDMSOmaha platform via a VPN or PPP (dial-up) connection. This component can be integrated into web pages or stand-alone Point Of Sale applications.

The FDMSOmahaRetail component makes authorizing Card-Present transactions (where the customer's card is swiped through a card reader) very easy by adding an additional layer of abstraction between the programmer and the protocol. There is no need to deal with raw sockets, TLS/SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:

FDMSOmahaRetail.MerchantNumber = "123456789123456"
FDMSOmahaRetail.MerchantTerminalID = "XXX01"
FDMSOmahaRetail.DeviceId = "DID1" // Optional, Merchant-Assigned

Next, set properties that contain details about the transaction. At the minimum, you must set a BatchNumber, TransactionNumber, and TransactionAmount. The TransactionNumber is a sequence number, and should be incremented (for Credit Card transactions) or decremented (for Debit/EBT Card transactions) for each transaction you send. TransactionAmount is the amount of sale formatted with two decimal places.

FDMSOmahaRetail.BatchNumber = 1
FDMSOmahaRetail.TransactionNumber = 1
FDMSOmahaRetail.TransactionAmount = "1.00"

Now for Credit Card transactions, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing Track1, and for these cards you may use Track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with Track1 data.

FDMSOmahaRetail.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?"
FDMSOmahaRetail.Card.EntryDataSource = edsTrack1

For Debit Card transactions, set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction.

FDMSOmahaRetail.TransactionNumber = 999
FDMSOmahaRetail.Card.EntryDataSource = edsTrack2
FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001"
FDMSOmahaRetail.DebitKSN = "876543210A005611119"
FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

For EBT Card transactions, first set the EBTPaymentType to the card type being used. Then set the Track2 Card data along with the DebitPIN and DebitKSN. Additionally you will need to set the TransactionNumber as Debit/EBT transactions start at 999 and decrement after each successful transaction.

FDMSOmahaRetail.TransactionNumber = 998
FDMSOmahaRetail.EBTPaymentType = etCashBenefits
FDMSOmahaRetail.Card.EntryDataSource = edsTrack2
FDMSOmahaRetail.Card.MagneticStripe = "4017779999999999=16041200000000001"
FDMSOmahaRetail.DebitKSN = "876543210A005611119"
FDMSOmahaRetail.DebitPIN = "8741F3581F20D1D1"

Finally, submit the transaction by calling Sale. The following code demonstrates a purchase:

FDMSOmahaRetail.Sale()

For Credit Card transactions only, you can use the AuthOnly transaction.

For Debit and EBT transactions, the DebitRefund method can also be called.

For EBT transactions only, the EBTBalanceInquiry and EBTCashWithdrawal can be called.

When the component receives a response from the FDMS FDMSOmaha servers, the result of the authorization will be displayed in the Response properties. ResponseSuccess indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.

Once a Sale, DebitRefund, or EBTCashWithdrawal transaction is approved, the DetailAggregate must be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

For AuthOnly transactions, they must first be captured via the FDMSOmahaDetailRecord component for the funds to be flagged for transfer. Once captured the DetailAggregate can then be added to the FDMSOmahaBatchMgr component to be used when the batch is closed.

After all the wanted detail records have been added to the FDMSOmahaBatchMgr component, the batch can be closed to start the settlement process and initiate the transfer of the funds.