Properties   Methods   Events   Configuration Settings  

The CCRetail 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, grocery or food stores, Hotels, and Auto Rental businesses.

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 allows for simple, direct, secure connection to the Vital/TSYS SSL gateway through a standard Internet connection. 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 CCRetail 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, set the merchant properties with setup information acquired from your member bank or processor. For instance:

component.MerchantBankId = "999995" '(BIN number) component.MerchantCategoryCode = "5999" component.MerchantName = "test merchant" component.MerchantNumber = "123456789012" component.MerchantCity = "Beverly Hills" component.MerchantState = "CA" component.MerchantStoreNumber = "5999" component.MerchantTerminalNumber = "1515" component.MerchantZip = "90210"

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount, TransactionNumber, and IndustryType.

component.TransactionAmount = "100" component.TransactionNumber = 1 component.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.

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

Finally, submit the transaction by calling the Authorize method.

When the component receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The Response indicates whether the transaction was approved, and the Response indicates whether the customer's billing address on file with his credit card company matches the information presented in the CustomerAddress and CustomerZip properties. 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 CCSETTLE component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.

/n software suggests that as a matter of good business practices all merchants and third parties that store cardholder data should be aware of the Visa Cardholder Information Security Program (CISP) and the MasterCard Site Data Protection (SDP) program. The purpose of these programs is to help protect the integrity of cardholder information via the use of outside-vendor auditing of systems security and server site security.

Property List

---

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

Card	Contains the customer's credit card information.
CardPresent	Indicates whether the current transaction is a card present transaction.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
IndustryType	Code which indicates the industry the merchant is engaged in.
Merchant	Contains the merchant's setup information.
PrestigiousIndicator	Prestigious Lodging Program indicator for the Hotel Industry Type.
RentalDuration	Duration of an auto rental or hotel stay.
Response	Contains the response to an authorization request.
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.
Timeout	A timeout for the component.
TransactionAmount	Purchase amount to be authorized.
TransactionNumber	Sequence number of this transaction.

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	Sends an authorization 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.

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.

Configuration Settings

---

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

CardholderId	Specifies the method used to verify the identity of the cardholder
CustomerAddress	Customer's billing address, used for Manually Keyed transactions
CustomerZip	Zip code portion of the customer's billing address, used for Manually Keyed transactions
IncrementalTransId	Transaction Id associated with authorization to increment
DeveloperId	Number that indicates the software's origin to the TSYS network
Port	The port to which transactions are posted
Retry	Set this to retry a failed transaction
Server	The server to which transactions are posted
VersionId	Indicates the software's version to the Vital network
ResponseStoreNumber	Check this field against the original Merchant StoreNumber
ResponseTerminalNumber	Check this field against the original Merchant TerminalNumber
ACI	Requested Authorization Characteristics Indicator (ACI)
CountryCode	Identifies the country where the merchant is located
CurrencyCode	Identifies the type of currency used by the merchant
MerchantLanguage	Designates the language that response messages will be returned in
SendCommCardInd	Indicates whether to send Commercial Card Request Indicator
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 (Windows/COM only)