4D Payments SDK 2016 .NET Edition
4D Payments SDK 2016 .NET Edition
Questions / Feedback?

FDMSOmahaECommerce Component

Properties   Methods   Events   Configuration Settings   Errors  

The FDMSOmahaECommerce component is used to perform Credit card transactions in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet.




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 FDMSOmahaECommerce component makes authorizing Card-Not-Present transactions (where the customer's card is manually entered) 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:

FDMSOmahaECommerce.MerchantNumber = "123456789123456"
FDMSOmahaECommerce.MerchantTerminalID = "XXX01"
FDMSOmahaECommerce.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 each transaction you send. TransactionAmount is the amount of sale formatted with two decimal places. Additionally you can set the DirectMarketingType to specify the transaction type you wish to process.

FDMSOmahaECommerce.BatchNumber = 1
FDMSOmahaECommerce.TransactionNumber = 1
FDMSOmahaECommerce.TransactionAmount = "1.00"
FDMSOmahaECommerce.DirectMarketingType = dmECommerce

Now set the credit card properties, as well as the card holder's address and zip code (the address and zip code will be checked by the FDMS servers to make sure it matches the customer's billing address). Note: card data must be manually entered.

FDMSOmahaECommerce.Card.EntryDataSource = edsManualEntryNoCardReader
FDMSOmahaECommerce.Card.Number = "4444333322221111"
FDMSOmahaECommerce.Card.ExpMonth = 1
FDMSOmahaECommerce.Card.ExpYear = 2013
FDMSOmahaECommerce.CardCVVData = "999"
FDMSOmahaECommerce.CustomerAddress = "8320 Hightower"
FDMSOmahaECommerce.CustomerZip = "85284"  

Finally, submit the transaction by calling Sale or AuthOnly. The following code demonstrates a sale:


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.

Once a Sale 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.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

ApplicationIdIdentifies the merchant application to the Datawire System.
BatchNumberNumber identifying the batch (assigned by the POS device).
CardContains the customer's credit card information.
ClientRefUniquely identifies the transaction within the Datawire system.
CustomerAddressThe customer's street number of the billing address.
CustomerCodeMerchant-assigned customer code.
CustomerZipCodeCustomer's zip code (or postal code if outside of the USA).
DatawireIdIdentifies the merchant to the Datawire System.
DeviceIdPOS Device Identification.
DirectMarketingTypeSpecifies the type of transaction to process.
InvoiceNumberMerchant-defined invoice number.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where IPPort binds.
MerchantNumberA unique number used to identify the merchant within the FDMS systems.
MerchantTerminalIDUsed to identify a unique terminal within a merchant location.
OperatorIDMerchant-assigned operator code identifying the operator who entered the transaction.
OrderNumberMerchant-defined number identifying the purchase or service.
ProxyA set of properties related to proxy access.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe TCP port in the remote host.
ResponseContains the response to an authorization request.
ShipToZipCodeThe zip code where the purchased items will be shipped to.
SSLAcceptServerCertInstructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to be used during SSL negotiation.
SSLServerCertThe server certificate for the last established connection.
TaxAmountDollar-and-cent amount of tax for the purchase.
TimeoutA timeout for the component.
TPPIDThird Party Processor Identifier assigned by FDMS.
TransactionAmountPurchase amount to be charged to the cardholders account.
TransactionNumberThe transaction number for the current transaction.
URLLocation of the Datawire server to which transactions are sent.
VisaIdentifierAdditional merchant identification field used when authorizing Visa transactions.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

AuthOnlySends an Authorization Only request.
ConfigSets or retrieves a configuration setting .
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
InterruptInterrupts the current action.
ResetClears all properties to their default values.
SaleSends a sale request for Credit, Debit, and EBT cards. Authorizes a credit card using track1, track2, or manually entered card data.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StatusShows the progress of the FDMS/Datawire connection.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for further details.

ACIRequested Authorization Characteristics Indicator (ACI).
AllowPartialAuthsIndicates whether partial authorizations are to be supported.
ECIElectronic Commerce Indicator.
CAVVAuthenticationCAVV data from the ThreeDSecure component.
XIDTransactionId from a 3D Secure authentication.
UseEncryptionChannelSpecifies whether First Data should use the SST Encryption Channel.
TerminalCapabilitiesThe list of capabalities available for the terminal.
ResponseRoutingCodeThe routing code response.
ResponseSignatureCodeThe signature code response.
ResponseNetworkNameThe name of the authorization network.
TransportProtocolSpecifies the transport protocol to use to communicate with the FDMS Omaha server.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
UseNTLMv2Whether to use NTLM V2.
CloseStreamAfterTransferIf true, the component will close the upload or download stream after the transfer.
TcpNoDelayWhether or not to delay when sending packets.
CACertFilePathsThe paths to CA certificate files when using Mono on Unix/Linux.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
GUIAvailableTells the component whether or not a message loop is available for processing events.
UseBackgroundThreadWhether threads created by the component are background threads.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2018 4D Payments Inc. - All rights reserved.
4D Payments SDK 2016 .NET Edition - Version 16.0 [Build 6863]