Properties   Methods   Events   Configuration Settings  

The CCECommerce component is an advanced tool used to authorize credit cards in both Mail Order (Direct Marketing) and eCommerce environments, where the customer is ordering products or services via the telephone or Internet. This component makes authorizing these types of transactions very easy.

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 CCECommerce component makes authorizing Card-Not-Present Mail Order and E-Commerce transactions 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.MerchantServiceNumber = "800-1234567"
  component.MerchantState = "CA"
  component.MerchantStoreNumber = "5999"
  component.MerchantTerminalNumber = "1515"
  component.MerchantZip = "90210"

Then, set the customer's credit card information, as well as his address and zip code (the address and zip code will be checked by the Vital/TSYS servers to make sure it matches the customer's billing address).

  component.CardNumber = "4444333322221111"
  component.CardExpMonth = 1
  component.CardExpYear = 2009
  component.CardCVVData = "999"
  component.CustomerAddress = "8320 South Hardy Dr."
  component.CustomerZip = "85284"  

Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount and TransactionNumber. However, you may also set the TransactionType if you are doing a Mail Order or Recurring transaction.

  component.TransactionAmount = "100"
  component.TransactionNumber = 1
  component.TransactionType = ttECommerce

Finally, submit the transaction by calling the Authorize method. 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.

Note: The CCECommerce component can be used to pass 3D-Secure authentication data in an authorization to achieve a better interchange rate. To send this data, the ECI, XID, and CAVV configuration variables must be set before calling Authorize. The CAVV authentication result code will be returned in the ResponseCAVV configuration setting.

Further Note: When sending e-commerce transactions, you must send a PurchaseIdentifier (sometimes referred to as Invoice Number) in the settlement. This can be done via the PurchaseIdentifier property of the CCDETAILRECORD component. Failure to set a PurchaseIdentifier for the e-commerce Industry Type may result in a CPS downgrade when the transaction is settled, and can cause higher interchange rates.

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 card (optional).
CardEntryDataSource	This property contains a 1-character code identifying the source of the customer data.
CardExpMonth	Expiration month of the credit card specified in CardNumber .
CardExpYear	Expiration year of the credit card specified in CardNumber .
CardMagneticStripe	Track data read off of the card's magnetic stripe.
CardNumber	Customer's credit card number.
CustomerAddress	The customer's billing address.
CustomerZip	Customer's zip code (or postal code if outside of the USA).
GoodsIndicator	Used to identify the type of goods purchased over the Internet.
MerchantBankId	The number which identifies the merchant's bank or processor.
MerchantCategoryCode	Classifies a merchant by the type of store.
MerchantCity	Merchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
MerchantCountryCode	Identifies the country where the merchant is located.
MerchantCurrencyCode	Identifies the type of currency used by the merchant.
MerchantLanguage	Designates the language that response messages will be returned in.
MerchantName	Name of the merchant.
MerchantNumber	A unique number used to identify the merchant within the VisaNet system.
MerchantServicePhone	Merchant's customer service number.
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.
ResponseApprovalCode	Contains an authorization code when a transaction has been approved.
ResponseAuthSource	Indicates the source of the authorization code stored in ApprovalCode .
ResponseAVSResult	Contains the Address Verification System result code.
ResponseCardLevel	This property contains a two-character code created by Visa during the authorization process.
ResponseCode	Indicates the status of the authorization request.
ResponseCommercialCardType	Response property that indicates whether the card is a commercial card.
ResponseCVVResult	Contains the returned CVV result code if it was requested.
ResponseRetrievalNumber	This number is to be submitted for reversals or at settlement.
ResponseReturnedACI	Returned Authorization Characteristics Indicator contains CPS qualification status.
ResponseText	Text information that describes each response code.
ResponseTransactionDate	Local transaction date returned from the server in MMDDYY format.
ResponseTransactionId	Contains the Transaction Identifier or MasterCard Reference Number.
ResponseTransactionNumber	Check this property against the original Transaction Number.
ResponseTransactionTime	Local transaction time returned from the server in HHMMSS format.
ResponseValidationCode	This optional property contains 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.
TransactionAmount	Purchase amount to be authorized.
TransactionNumber	Sequence number of this transaction.
TransactionType	Specifies the type of transaction to process.

Method List

---

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

AuthenticateCard	Determines only if a card has been lost or stolen.
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.

IncrementalTransId	Transaction Id associated with authorization to increment.
CardholderId	Specifies the method used to verify the identity of the cardholder.
ECI	Electronic Commerce Indicator.
DeveloperId	Number that indicates the software's origin to the TSYS network.
Retry	Set this to retry a failed transaction.
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.
Port	The port to which transactions are posted.
Server	The server to which transactions are posted.
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.
PurchaseIdentifier	Optional purchase order number assigned by the merchant.
CAVV	AuthenticationCAVV data from the ThreeDSecure component.
ResponseCAVV	Used for 3D-Secure transactions. Indicates whether the submitted CAVV value passed validation.
XID	TransactionId from a 3D Secure authentication.
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.