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.
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:
For Credit Card transactions only, you can use the AuthOnly transaction.
For Debit and EBT transactions, the DebitRefund method can also 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. Success indicates whether the transaction was approved. The remaining properties provide additional information about the transaction.
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.
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
|ApplicationId||Identifies the merchant application to the Datawire System.|
|BatchNumber||Number identifying the batch (assigned by the POS device).|
|Card||Contains the customer's credit card information.|
|ClientRef||Uniquely identifies the transaction within the Datawire system.|
|CustomerCode||Merchant-assigned customer code.|
|DatawireId||Identifies the merchant to the Datawire System.|
|DebitCashBackAmount||Optional cash back amount to return to the customer.|
|DebitKSN||Clear-text Key Sequence Number, used for Debit and EBT transactions.|
|DebitPIN||DUKPT DES encrypted PIN block, used for Debit and EBT transactions.|
|DeviceId||POS Device Identification.|
|EBTPaymentType||Indicates the type of EBT transaction to process.|
|EBTVoucherCode||Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.|
|EBTVoucherNumber||Used to clear (force) a Food Stamp Voucher that was previously voice-authorized.|
|InvoiceNumber||Merchant-defined invoice number.|
|LocalHost||The name of the local host or user-assigned IP interface through which connections are initiated or accepted.|
|LocalPort||The TCP port in the local host where IPPort binds.|
|MerchantNumber||A unique number used to identify the merchant within the FDMS systems.|
|MerchantTerminalID||Used to identify a unique terminal within a merchant location.|
|OperatorID||Merchant-assigned operator code identifying the operator who entered the transaction.|
|OrderNumber||Merchant-defined number identifying the purchase or service.|
|Proxy||A set of properties related to proxy access.|
|RemoteHost||The address of the remote host. Domain names are resolved to IP addresses.|
|RemotePort||The TCP port in the remote host.|
|Response||Contains the response to an authorization request.|
|ShipToZipCode||The zip code where the purchased items will be shipped to.|
|SSLAcceptServerCert||Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.|
|SSLCert||The certificate to be used during SSL negotiation.|
|SSLServerCert||The server certificate for the last established connection.|
|TaxAmount||Dollar-and-cent amount of tax for the purchase.|
|Timeout||A timeout for the component.|
|TPPID||Third Party Processor Identifier assigned by FDMS.|
|TransactionAmount||Purchase amount to be charged to the cardholders account.|
|TransactionNumber||The transaction number for the current transaction.|
|URL||Location of the Datawire server to which transactions are sent.|
|VisaIdentifier||Additional merchant identification field used when authorizing Visa transactions.|
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
|AuthOnly||Sends an Authorization Only request.|
|Config||Sets or retrieves a configuration setting .|
|DebitRefund||Sends a Refund request for a Debit or EBT card.|
|DebitVoidTransaction||Sends a void request for a previous debit card transaction.|
|EBTBalanceInquiry||Sends a Balance Inquiry request for EBT.|
|EBTCashWithdrawal||Sends a withdrawal request for EBT Cash Benefit cards.|
|GetDetailAggregate||Returns an aggregate containing details of this transaction, which is then used for settlement.|
|Interrupt||Interrupts the current action.|
|OnlineRefund||Sends a Refund request for a Visa/Visa Electron Credit card.|
|Reset||Clears all properties to their default values.|
|Sale||Sends a sale request for Credit, Debit, and EBT cards. Authorizes a credit card using track1, track2, or manually entered card data.|
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
|Connected||Fired immediately after a connection completes (or fails).|
|DataPacketIn||Fired when receiving a data packet from the transaction server.|
|DataPacketOut||Fired when sending a data packet to the transaction server.|
|Disconnected||Fired when a connection is closed.|
|Error||Information about errors during data delivery.|
|SSLServerAuthentication||Fired after the server presents its certificate to the client.|
|SSLStatus||Shows the progress of the secure connection.|
|Status||Shows the progress of the FDMS/Datawire connection.|
The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.
|ACI||Requested Authorization Characteristics Indicator (ACI).|
|AllowPartialAuths||Indicates whether partial authorizations are to be supported.|
|CustomerAddress||The customer's street number of the billing address.|
|CustomerZip||Customer's zip code (or postal code if outside of the USA).|
|DebitSurcharge||Dollar-and-cent amount ($$$.cc) of the charge that the cardholder paid the merchant for the ability to perform the transaction.|
|IsPrepaidCard||Indicates that the specified card is a prepaid card.|
|TerminalCapabilities||The list of capabalities available for the terminal.|
|ResponseRoutingCode||The routing code response.|
|ResponseSignatureCode||The signature code response.|
|ResponseNetworkName||The name of the authorization network.|
|TransportProtocol||Specifies the transport protocol to use to communicate with the FDMS Omaha server.|
|ConnectionTimeout||Sets a separate timeout value for establishing a connection.|
|FirewallAutoDetect||Tells the component whether or not to automatically detect and use firewall system settings, if available.|
|FirewallHost||Name or IP address of firewall (optional).|
|FirewallListener||If true, the component binds to a SOCKS firewall as a server (IPPort only).|
|FirewallPassword||Password to be used if authentication is to be used when connecting through the firewall.|
|FirewallPort||The TCP port for the FirewallHost;.|
|FirewallType||Determines the type of firewall to connect through.|
|FirewallUser||A user name if authentication is to be used connecting through a firewall.|
|KeepAliveTime||The inactivity time in milliseconds before a TCP keep-alive packet is sent.|
|KeepAliveInterval||The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.|
|Linger||When set to True, connections are terminated gracefully.|
|LingerTime||Time in seconds to have the connection linger.|
|LocalHost||The name of the local host through which connections are initiated or accepted.|
|LocalPort||The port in the local host where the component binds.|
|MaxLineLength||The maximum amount of data to accumulate when no EOL is found.|
|MaxTransferRate||The transfer rate limit in bytes per second.|
|ProxyExceptionsList||A semicolon separated list of hosts and IPs to bypass when using a proxy.|
|TCPKeepAlive||Determines whether or not the keep alive socket option is enabled.|
|UseIPv6||Whether to use IPv6.|
|UseNTLMv2||Whether to use NTLM V2.|
|CloseStreamAfterTransfer||If true, the component will close the upload or download stream after the transfer.|
|TcpNoDelay||Whether or not to delay when sending packets.|
|CACertFilePaths||The paths to CA certificate files when using Mono on Unix/Linux.|
|LogSSLPackets||Controls whether SSL packets are logged when using the internal security API.|
|ReuseSSLSession||Determines if the SSL session is reused.|
|SSLCipherStrength||The minimum cipher strength used for bulk encryption.|
|SSLEnabledProtocols||Used to enable/disable the supported security protocols.|
|SSLIncludeCertChain||Whether the entire certificate chain is included in the SSLServerAuthentication event.|
|SSLProvider||The name of the security provider to use.|
|SSLSecurityFlags||Flags that control certificate verification.|
|SSLCACerts||A newline separated list of CA certificate to use during SSL client authentication.|
|SSLEnabledCipherSuites||The cipher suite to be used in an SSL negotiation.|
|TLS12SignatureAlgorithms||Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.|
|TLS12SupportedGroups||The supported groups for ECC.|
|TLS13KeyShareGroups||The groups for which to pregenerate key shares.|
|TLS13SupportedGroups||The supported groups for (EC)DHE key exchange.|
|TLS13SignatureAlgorithms||The allowed certificate signature algorithms.|
|AbsoluteTimeout||Determines whether timeouts are inactivity timeouts or absolute timeouts.|
|FirewallData||Used to send extra data to the firewall.|
|InBufferSize||The size in bytes of the incoming queue of the socket.|
|OutBufferSize||The size in bytes of the outgoing queue of the socket.|
|GUIAvailable||Tells the component whether or not a message loop is available for processing events.|
|UseBackgroundThread||Whether threads created by the component are background threads.|
|UseInternalSecurityAPI||Tells the component whether or not to use the system security libraries or an internal implementation.|