FDMSOmahaBatchMgr Control

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSOmahaBatchMgr component is used to close batches and also handles the sending of all offline transactions to the FDMS Host.

Syntax

FDMSOmahaBatchMgr

Remarks

This component allows for a connection to the FDMS Omaha 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 FDMSOmahaBatchMgr component makes sending offline transactions and closing batches 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:

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

Next, add all the detail records for the transactions you wish to settle in the batch. Note that all the added detail records must be transactions that are processed within the same batch that you wish to close. Below is an example of how to add a detail record to the OmahaBatchMgr component.

FDMSOmahaBatchMgr.DetailRecordCount = 1;
FDMSOmahaBatchMgr.DetailRecordAggregate[0] = FDMSOmahaRetail.GetDetailAggregate()

The BatchNumber and TransactionNumber should then be set. Note the BatchNumber should be the same value as all the transactions contained within the DetailRecords. The TransactionNumber specified must be 1 greater than the number of Credit Card transactions specified within DetailRecords and less than the last Debit/EBT Card TransactionNumber specified. See TransactionNumber for more specific information.

FDMSOmahaBatchMgr.BatchNumber = 1
FDMSOmahaBatchMgr.TransactionNumber = 2

Finally the batch can be closed by calling CloseBatch. When CloseBatch is called, all the off-line transactions (Voids, Revisions, etc.) will be sent to the Host. After all the off-line transactions have been successfully sent, the batch close request will be sent. If the batch was successfully closed, ResponseSuccess will be 'True'.

FDMSOmahaBatchMgr.CloseBatch()

Note it is possible that the Host may be out-of-balance with the Total Amount specified (which is calculated by the component based on the information contained within the DetailRecords). If such a case occurs, the Host may request an inquiry to synchronize all transactions (this request is sent after a batch close message is sent by the component). When the component receives this request, it will handle all inquiries and respond accordingly based on the request and information contained within DetailRecords. Once the host is in sync, the Host will send the close batch response and Response will be populated. ResponseSuccess will be true if the batch was successfully closed.