Properties   Methods   Events   Configuration Settings  

The FDMSRetail Component is an advanced tool used to authorize credit cards in a Retail environment, where the customer is purchasing products or services in person. This component makes authorizing these types of transactions very easy. Supported Industry Types include retail stores, restaurants, and grocery or food stores.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

This component connects to the First Data Merchant Services (FDMS) processor, by way of the Datawire VXN transaction transport network. Transactions originating with these components go through Datawire, to the FDMS processor where the transaction is authorized. The result is then returned back through Datawire and received by the component. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated SSL servers.

The FDMSRetail 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, SSL handshakes, or data packet formatting. The steps to setting up the component and authorizing a transaction are outlined below:

First, you must register and activate your account with Datawire. Datawire will provide you with a MerchantNumber and MerchantTerminalNumber, but you'll need to use the FDMSREGISTER component to activate the merchant and receive a DatawireId. Once you acquire the DatawireId and receive your transaction URLs through Service Discovery, you may begin to authorize transactions.

To authorize a credit card, set the MerchantNumber and MerchantTerminalNumber with the values supplied by FDMS and Datawire, and the DatawireId with the value retrieved by the FDMSREGISTER component after activating your merchant account. Set the URL property with one of the URLs you retrieved during Service Discovery.

  FDMSRetail.MerchantNumber = "000000999990"                 'Supplied by FDMS/Datawire
  FDMSRetail.MerchantTerminalNumber = "555555"         'Supplied by FDMS/Datawire
  FDMSRetail.DatawireId = "0000B47FFFFFFFFFFFFF"
                                'Retrieved with the FDMSREGISTER Component.
  
  FDMSSettle.URL = "https://staging1.datawire.net/sd/"         'Retrieved with the FDMSREGISTER Component.

Next, set properties that contain details about the transaction. The TransactionNumber should be incremented for every transaction you authorize. The TransactionAmount must be set, and it should contain the amount to be charged, with an implied decimal point (ie: $1.00 is "100"). The IndustryType will indicate whether the transaction is made for a Retail store, a restaurant, or a grocery store.

  FDMSRetail.TransactionNumber = 1
  FDMSRetail.TransactionAmount = "100"
  FDMSRetail.IndustryType = itRetail

Now, 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.

  FDMSRetail.CardMagneticStripe = "%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?"
  FDMSRetail.CardEntryDataSource = edsTrack1  

Finally, submit the transaction by calling the Authorize method.

When the component receives a response, the result of the authorization will be displayed in several Response properties. The Response and Response indicate whether any errors occured while passing the transaction through the Datawire VXN system. These two properties alone do not indicate a successful transaction, they only tell whether or not there were any problems transporting the authorization request and response through the Datawire system. If the transaction was successfully authorized by FDMS, then the Response will be True, and the Response will contain an approval code. The remaining properties provide additional information about the transaction.

Once an authorization request is approved, the money in the customer's account is blocked and tagged for the merchant. This transaction must go through the Batch Settlement process in order for the blocked money to be transferred to the merchant account. This is done by passing the XML aggregate returned from the GetDetailAggregate method to the FDMSSETTLE component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

Property List

---

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

CardCVVData	Three digit security code on back of credit card (optional).
CardEntryDataSource	Determines the manner in which a cardholder's information is being sent to the Host.
CardExpMonth	Expiration month of the credit card specified by Number .
CardExpYear	Expiration year of the credit card specified by Number .
CardMagneticStripe	Track data read off of the credit card's magnetic stripe.
CardNumber	Customer's credit card number.
DatawireId	Identifies the merchant to the Datawire System.
IndustryType	Code which indicates the industry the merchant is engaged in.
MerchantNumber	A unique number used to identify the merchant within the FDMS and Datawire systems.
MerchantTerminalNumber	Used to identify a unique terminal within a merchant location.
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.
ResponseApprovalCode	Contains an authorization code when a transaction has been approved, or an error message if declined.
ResponseAuthorizedAmount	If supporting partial authorizations, this is the amount actually charged to the credit card.
ResponseAVSResult	Contains the Address Verification System result code.
ResponseCaptureFlag	Indicates whether the authorization was successful, and whether it can be settled.
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).
ResponseDatawireReturnCode	Contains an error code providing more details about the DatawireStatus received.
ResponseDatawireStatus	Status of the communication with Datawire.
ResponseReturnedACI	Returned Authorization Characteristics Indicator contains CPS qualification status.
ResponseTransactionDate	Local transaction date returned from the server in MMDDYY format.
ResponseTransactionId	Contains the Visa Transaction Identifier or MasterCard Reference Number.
ResponseValidationCode	Additional information generated by the card issuer.
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).
Timeout	A timeout for the component.
TPPID	Third Party Processor Identifier assigned by FDMS.
TransactionAmount	Purchase amount to be authorized.
TransactionNumber	Uniquely identifies the 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.

Authorize	Authorizes a credit card using track1, track2, or manually entered card data.
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.

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).
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.

ClientTimeout	Indicates timeout client application will wait for response.
CurrencyCode	Currency Code for this transaction.
ACI	Requested Authorization Characteristics Indicator (ACI).
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
CardLevelResults	Visa Card Level Results returned in the response.
Healthcare	Indicates this is a Healthcare auto-substantiation transaction.
ClinicItems	Total amount of Clinic or Other qualified medical items for Healthcare auto-substantiation.
DentalItems	Total amount of Dental items for Healthcare auto-substantiation.
PrescriptionItems	Total amount of Prescription/Rx items for Healthcare auto-substantiation.
VisionItems	Total amount of Vision or Optical items for Healthcare auto-substantiation.
MedicalItemsTotal	Sum total of the above medical items.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
Authorization	The Authorization string to be sent to the server.
EncodeURL	If set to true the URL will be encoded by the component.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxHeaders	Instructs component to save the amount of headers specified that are returned by the server after a Header event has been fired.
MaxHTTPCookies	Instructs component to save the amount of cookies specified that are returned by the server when a SetCookie event is fired.
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
UsePlatformHTTPClient	Whether or not to use the platform HTTP client.
UserAgent	Information about the user agent (browser).
UseWinInet	If set, the WinInet API is used for retrieving the URL.
UseWinInetCookies	Controls whether to send and accept cookies when making HTTP requests through WinInet.
UseIPv6	Whether or not to use IPv6.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
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;.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
FirewallType	Determines the type of firewall to connect through.
TcpNoDelay	Whether or not to delay when sending packets.
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.