Search: 
Available in: VITALPS
CCRetail Component [IBiz Vital/TSYS Integrator V4]

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.MerchantLocation = "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

Finally, submit the transaction by calling one of the three Authorization methods: AuthorizeTrack1, AuthorizeTrack2, and ManualAuthorize. Most card readers are capable of reading both Track1 and Track2 data off of a credit card. If both are present and correctly read, you should default to sending Track1 data. If your card reader cannot read the card at all, you may manually enter the credit card number and expiration date using the ManualAuthorize method. For instance:

   
  component.AuthorizeTrack1("%B4444333322221111^SMITH/JOHN J         ^031210100000033301000000008000000?")
  'or
  component.ManualAuthorize("4444333322221111", 3, 2009) 'Card expires in March 2009
When the component receives a response from the Vital/TSYS servers, the result of the authorization will be displayed in several Response properties. The ResponseCode indicates whether the transaction was approved, and the ResponseAVS 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 complete descriptions.

CardPresent Indicates whether the current transaction is a card present transaction.
CommercialCardType Response property that indicates whether the card is a commercial card.
CustomerAddress The customer's billing address.
CustomerZip Customer's zip code (or postal code if outside of the USA).
FirewallHost Name or IP address of firewall (optional).
FirewallPassword A password if authentication is to be used when connecting through the firewall.
FirewallPort Port of the firewall to connect to.
FirewallType Determines the type of firewall to connect through.
FirewallUser A user name if authentication is to be used connecting through a firewall.
IndustryType Code which indicates the industry the merchant is engaged in.
MerchantBankId The number which identifies the merchant's bank or processor.
MerchantCategoryCode Classifies a merchant by the type of store.
MerchantLocation Merchant's location
MerchantName Name of the merchant.
MerchantNumber A unique number used to identify the merchant within the VisaNet system.
MerchantState State or province that the merchant is located in.
MerchantStoreNumber Used to identify a specific merchant's store within the VisaNet system.
MerchantTerminalNumber Used to identify a unique terminal within a merchant location.
MerchantTimeZone Specifies the GMT offset used to calculate the local time within the VisaNet system.
MerchantZip Zip code where the merchant that initiated this transaction is located.
PrestigiousIndicator Prestigious Lodging Program indicator for the Hotel Industry Type.
RentalDuration Duration of an auto rental or hotel stay.
ResponseACI Returned Authorization Characteristics Indicator contains CPS qualification status.
ResponseApprovalCode Contains an authorization code when a transaction has been approved.
ResponseAuthSource Indicates the source of the authorization code stored in ResponseApprovalCode.
ResponseCode Indicates the status of the authorization request.
ResponseRetrievalNumber This number is to be submitted for reversals or at settlement.
ResponseText Text information that describes each response code.
ResponseTransactionDate Local transaction date returned from the server in MMDDYY format.
ResponseTransactionId Contains the Visa Transaction Identifier or MasterCard Reference Number.
ResponseTransactionTime Local transaction time returned from the server in HHMMSS format.
ResponseValidationCode This optional field contain information generated by the card issuer.
SSLAcceptServerCert Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertEncoded The SSL certificate (PEM/base64 encoded).
SSLCertStore The name of the certificate store for the client certificate.
SSLCertStorePassword The password for the certificate store (if any).
SSLCertStoreType The type of certificate store for the client certificate.
SSLCertSubject The subject of the certificate used for client authentication.
SSLServerCert The server certificate for the last established connection.
SSLServerCertStatus The verification status of 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 complete descriptions.

AuthorizeTrack1 Authorizes a credit card using a track1 magnetic stripe read.
AuthorizeTrack2 Authorizes a credit card using a track1 magnetic stripe read.
Config Sets or retrieves a component configuration setting.
GetDetailAggregate Returns an aggregate containing details of this transaction, which is then used for settlement.
Interrupt Interrupts the current action.
ManualAuthorize Manually authorizes a credit card.
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 complete descriptions.

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 complete descriptions.

ACI Requested Authorization Characteristics Indicator (ACI)
AbsoluteTimeout Determines whether timeouts are inactivity timeouts or absolute timeouts.
AccountDataSource This property contains a 1-character code identifying the source of the customer data.
CardholderId Specifies the method used to verify the identity of the cardholder.
CodePage The system code page used for Unicode to Multibyte translations (Windows/COM only).
CountryCode Identifies the country where the merchant is located.
CurrencyCode Identifies the type of currency used by the merchant.
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
DeveloperId Number that indicates the software's origin to the TSYS network.
FirewallData Used to send extra data to the firewall.
FirewallListener If true, the component binds to a SOCKS firewall as a server (IPPort only).
HTTPVersion The version of HTTP used by the component
IfModifiedSince A date determining the maximum age of the desired document.
InBufferSize The size in bytes of the incoming queue of the socket.
KeepAlive Determines whether the HTTP connection is closed after the completion of the request.
MaxLineLength The maximum amount of data to accumulate when no EOL is found.
MaxTransferredData The maximum number of incoming bytes to be stored by the component.
MerchantLanguage Designates the language that response messages will be returned in.
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).
OutBufferSize The size in bytes of the outgoing queue of the socket.
Port The port to which transactions are posted.
ProxyAuthorization The authorization string to be sent to the proxy server.
ProxyPassword A password if Basic 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 Basic authentication is to be used for the proxy.
Retry Set this to retry a failed transaction.
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
SendCommCardInd Indicates whether to send Commercial Card Request Indicator
Server The server to which transactions are posted.
SocketHandle The handle of the main socket used by the component.
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
UserAgent Information about the user agent (browser).
VersionId Indicates the software's version to the Vital network.
WinsockInfo Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets Maximum number of sockets available to a single process (Windows only)
WinsockPath The path to the Winsock DLL used (Windows only)
WinsockStatus The status of the Winsock stack (Windows only)

| About | Privacy Policy | Terms of Use |
© Copyright 2008 /n software inc.