Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

FDMSOmahaECommerce Control

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.

Syntax

FDMSOmahaECommerce

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 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.CardEntryDataSource = edsManualEntryNoCardReader
FDMSOmahaECommerce.CardNumber = "4444333322221111"
FDMSOmahaECommerce.CardExpMonth = 1
FDMSOmahaECommerce.CardExpYear = 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:

FDMSOmahaECommerce.Sale()

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 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 control 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).
CardCVVDataThree digit security code on back of card (optional).
CardCVVPresenceIndicates the presence of the card verification value.
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in Number .
CardExpYearExpiration year of the credit card specified in Number .
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number for the transaction.
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.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RemoteHostThe address of the remote host. Domain names are resolved to IP addresses.
RemotePortThe TCP port in the remote host.
ResponseAuthCodeThe Authorization Code returned from the server after a successful transaction authorization.
ResponseAuthorizedAmountWhen supporting partial authorizations, this is the amount actually charged to the credit card.
ResponseAVSResultContains the Address Verification System result code.
ResponseBalanceContains the remaining available balance left on the card.
ResponseBatchNumberNumber identifying the batch assigned by the POS device.
ResponseCommercialCardIndicates whether the credit card charged is a corporate commercial card.
ResponseCVVResultContains the returned CVV result code (if CVV data was sent in the request).
ResponseDebitNetworkThe name of the network through which the debit card was processed.
ResponseDebitCardTypeNumberThe number of the debit network through which the debit card was processed.
ResponseEBTResponseCodeThe response code sent by the network that processed the transaction.
ResponseRequestedAmountThe amount entered at the Point of Sale device to be authorized.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseRevisionNumberRevision number of the online transaction.
ResponseSuccessDetermines whether the transaction was successful.
ResponseTextMessage from the Host describing the transaction.
ResponseTransactionIdContains the Visa Transaction Identifier or MasterCard Reference Number.
ResponseTransactionNumberNumber of the transaction in the batch as specified by the Point of Sale device.
ShipToZipCodeThe zip code where the purchased items will be shipped to.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
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 control 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 control 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 control 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).
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 TCP 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.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
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.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0