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.
Syntax
TibcFDMSOmahaECommerce
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 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). |
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
ClientRef | Uniquely identifies the transaction within the Datawire system. |
CustomerAddress | The customer's street number of the billing address. |
CustomerCode | Merchant-assigned customer code. |
CustomerZipCode | Customer's zip code (or postal code if outside of the USA). |
DatawireId | Identifies the merchant to the Datawire System. |
DeviceId | POS Device Identification. |
DirectMarketingType | Specifies the type of transaction to process. |
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. |
ProxyAuthScheme | This property is used to tell the component which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the component whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
RemoteHost | The address of the remote host. Domain names are resolved to IP addresses. |
RemotePort | The TCP port in the remote host. |
ResponseAuthCode | The Authorization Code returned from the server after a successful transaction authorization. |
ResponseAuthorizedAmount | When supporting partial authorizations, this is the amount actually charged to the credit card. |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseBalance | Contains the remaining available balance left on the card. |
ResponseBatchNumber | Number identifying the batch assigned by the POS device. |
ResponseCommercialCard | Indicates whether the credit card charged is a corporate commercial card. |
ResponseCVVResult | Contains the returned CVV result code (if CVV data was sent in the request). |
ResponseDebitNetwork | The name of the network through which the debit card was processed. |
ResponseDebitCardTypeNumber | The number of the debit network through which the debit card was processed. |
ResponseEBTResponseCode | The response code sent by the network that processed the transaction. |
ResponseRequestedAmount | The amount entered at the Point of Sale device to be authorized. |
ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
ResponseRevisionNumber | Revision number of the online transaction. |
ResponseSuccess | Determines whether the transaction was successful. |
ResponseText | Message from the Host describing the transaction. |
ResponseTransactionId | Contains the Visa Transaction Identifier or MasterCard Reference Number. |
ResponseTransactionNumber | Number of the transaction in the batch as specified by the Point of Sale device. |
ShipToZipCode | The zip code where the purchased items will be shipped to. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | If 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. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
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. |
Method List
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 . |
GetDetailAggregate | Returns an aggregate containing details of this transaction, which is then used for settlement. |
Interrupt | Interrupts the current action. |
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. |
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.
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. |
Configuration Settings
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. |
ECI | Electronic Commerce Indicator. |
CAVV | AuthenticationCAVV data from the ThreeDSecure component. |
XID | TransactionId from a 3D Secure authentication. |
UseEncryptionChannel | Specifies whether First Data should use the SST Encryption Channel. |
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). |
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 TCP 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. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
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. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
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. |
CodePage | The system code page used for Unicode to Multibyte translations. |