The Net Tools Company - 800.225.4190
Search: 
Available in: TSYS
CCECommerce Component [TSYS Integrator V6]

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.

CardCVVDataThree digit security code on back of card (optional).
CardEntryDataSourceThis property contains a 1-character code identifying the source of the customer data.
CardExpMonthExpiration month of the credit card specified in CardNumber .
CardExpYearExpiration year of the credit card specified in CardNumber .
CardMagneticStripeTrack data read off of the card's magnetic stripe.
CardNumberCustomer's credit card number.
CustomerAddressThe customer's billing address.
CustomerZipCustomer's zip code (or postal code if outside of the USA).
GoodsIndicatorUsed to identify the type of goods purchased over the Internet.
MerchantBankIdThe number which identifies the merchant's bank or processor.
MerchantCategoryCodeClassifies a merchant by the type of store.
MerchantCityMerchant's City For Retail (Card Present) transactions, this property should contain the city in which the merchant is located.
MerchantCountryCodeIdentifies the country where the merchant is located.
MerchantCurrencyCodeIdentifies the type of currency used by the merchant.
MerchantLanguageDesignates the language that response messages will be returned in.
MerchantNameName of the merchant.
MerchantNumberA unique number used to identify the merchant within the VisaNet system.
MerchantServicePhoneMerchant's customer service number.
MerchantStateState or province that the merchant is located in.
MerchantStoreNumberUsed to identify a specific merchant's store within the VisaNet system.
MerchantTerminalNumberUsed to identify a unique terminal within a merchant location.
MerchantTimeZoneSpecifies the GMT offset used to calculate the local time within the VisaNet system.
MerchantZipZip code where the merchant that initiated this transaction is located.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseAuthSourceIndicates the source of the authorization code stored in ApprovalCode .
ResponseAVSResultContains the Address Verification System result code.
ResponseCardLevelThis property contains a two-character code created by Visa during the authorization process.
ResponseCodeIndicates the status of the authorization request.
ResponseCommercialCardTypeResponse property that indicates whether the card is a commercial card.
ResponseCVVResultContains the returned CVV result code if it was requested.
ResponseRetrievalNumberThis number is to be submitted for reversals or at settlement.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseTextText information that describes each response code.
ResponseTransactionDateLocal transaction date returned from the server in MMDDYY format.
ResponseTransactionIdContains the Transaction Identifier or MasterCard Reference Number.
ResponseTransactionNumberCheck this property against the original Transaction Number.
ResponseTransactionTimeLocal transaction time returned from the server in HHMMSS format.
ResponseValidationCodeThis optional property contains information generated by the card issuer.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TransactionAmountPurchase amount to be authorized.
TransactionNumberSequence number of this transaction.
TransactionTypeSpecifies 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.

AuthenticateCardDetermines only if a card has been lost or stolen.
AuthorizeSends an authorization request.
ConfigSets or retrieves a configuration setting.
GetDetailAggregateReturns an aggregate containing details of this transaction, which is then used for settlement.
InterruptInterrupts the current action.
ResetClears 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.

ConnectedFired immediately after a connection completes (or fails).
DataPacketInFired when receiving a data packet from the transaction server.
DataPacketOutFired when sending a data packet to the transaction server.
DisconnectedFired when a connection is closed.
ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows 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.

IncrementalTransIdTransaction Id associated with authorization to increment.
CardholderIdSpecifies the method used to verify the identity of the cardholder.
ECIElectronic Commerce Indicator.
DeveloperIdNumber that indicates the software's origin to the TSYS network.
RetrySet this to retry a failed transaction.
VersionIdIndicates the software's version to the Vital network.
ResponseStoreNumberCheck this field against the original Merchant StoreNumber.
ResponseTerminalNumberCheck this field against the original Merchant TerminalNumber.
PortThe port to which transactions are posted.
ServerThe server to which transactions are posted.
ACIRequested Authorization Characteristics Indicator (ACI).
CountryCodeIdentifies the country where the merchant is located.
CurrencyCodeIdentifies the type of currency used by the merchant.
MerchantLanguageDesignates the language that response messages will be returned in.
SendCommCardIndIndicates whether to send Commercial Card Request Indicator.
PurchaseIdentifierOptional purchase order number assigned by the merchant.
CAVVAuthenticationCAVV data from the ThreeDSecure component.
ResponseCAVVUsed for 3D-Secure transactions. Indicates whether the submitted CAVV value passed validation.
XIDTransactionId from a 3D Secure authentication.
UseIPv6Whether or not to use IPv6.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallListenerIf true, the component binds to a SOCKS firewall as a server (IPPort only).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallUserA user name if authentication is to be used connecting through a firewall.
FirewallTypeDetermines the type of firewall to connect through.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.
| About | Privacy Policy | Terms of Use |
© Copyright 2011 /n software inc.