TSYSECommerce Control
Properties Methods Events Configuration Settings Errors
The TSYSECommerce 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.
Syntax
TSYSECommerce
Remarks
This control allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
The TSYSECommerce control 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, TLS/SSL handshakes, or data packet formatting. The steps to setting up the control and authorizing a transaction are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
control.MerchantBankId = "999995" '(BIN number) control.MerchantCategoryCode = "5999" control.MerchantName = "test merchant" control.MerchantNumber = "123456789012" control.MerchantServiceNumber = "800-1234567" control.MerchantState = "CA" control.MerchantStoreNumber = "5999" control.MerchantTerminalNumber = "1515" control.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).
control.CardNumber = "4444333322221111" control.CardExpMonth = 1 control.CardExpYear = 2009 control.CardCVVData = "999" control.CustomerAddress = "8320 South Hardy Dr." control.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.
control.TransactionAmount = "100" control.TransactionNumber = 1 control.TransactionType = ttECommerce
Finally, submit the transaction by calling the Authorize method. The control 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 ResponseAVSResult 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 TSYSSettle control. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.
Note: The TSYSECommerce control 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 TSYSDetailRecord control. 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 control with short descriptions. Click on the links for further details.
CardCVVData | Three digit security code on back of card (optional). |
CardCVVPresence | Indicates the presence of the card verification value. |
CardEntryDataSource | This property contains a 1-character code identifying the source of the customer data. |
CardExpMonth | Expiration month of the credit card specified in Number . |
CardExpYear | Expiration year of the credit card specified in Number . |
CardMagneticStripe | Track data read off of the card's magnetic stripe. |
CardNumber | Customer's credit card number for the transaction. |
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. |
ResponseAuthorizedAmount | Amount actually used from the card (used when supporting partial redemptions). |
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 used to identify transactions and should be submitted when making adjustments, 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 control 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 control 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. |
Response | Used with Interleaved Transaction Mode. |
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 control 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. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
AuthorizationIndicator | The type of authorization request. |
Retry | Set this to retry a failed transaction. |
SendExtendedAVS | Specifies whether to send extended AVS data. |
ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
ResponseCardholderVerification | Verification results for cardholder identification data (extended AVS). |
Port | The port to which transactions are posted. |
Server | The server to which transactions are posted. |
AuthenticationCode | An alphanumeric code provided to the POS user for input when authenticating a POS device. |
ActivateTerminal | Authenticates a POS device with TSYS. |
DeactivateTerminal | Deactivates a POS device with TSYS. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
ACI | Requested Authorization Characteristics Indicator (ACI). |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AmexCNPInternetPhoneData | Used by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions. |
AmexCPGoodsSoldData | Identifies merchandise such as gift cards, computers, and other electronics that can be resold for cash. |
CountryCode | Identifies the country where the merchant is located. |
CurrencyCode | Identifies the type of currency used by the merchant. |
IsBillPayment | Indicates that the transaction is a bill payment transaction. |
MerchantLanguage | Designates the language that response messages will be returned in. |
SendCommCardInd | Indicates whether to send Commercial Card Request Indicator. |
RetrieveToken | Sends a Token Only request. |
RequestToken | Indicates whether to request a token for the specified card data sent in an Authorize request. |
ResponseTokenStatus | The status of retrieval of the token. |
Token | The token received from the TSYS host when a token request is sent. |
PFIdentifier | The Payment Facilitator Identifier value assigned by MasterCard. |
PFNameSubMerchantName | The Payment Facilitator Name and Sub-Merchant name. |
PFSubMerchantIdentifier | The Payment Facilitator Sub-Merchant Identifier. |
PFSubMerchantCity | The Payment Facilitator Sub-Merchant City. |
PFSubMerchantState | The Payment Facilitator Sub-Merchant State. |
PFSubMerchantCountry | The Payment Facilitator Sub-Merchant Country Code. |
PFSubMerchantPostalCode | The Payment Facilitator Sub-Merchant Postal Code. |
Processor | Specifies the Processor you are connecting to. |
HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
HeartlandKeyBlock | Specifies the key block used to encrypt the data. |
InterleavedMode | Determines whether to use Interleaved Transaction Mode for authorization requests. |
InterleavedTimeout | Timeout value to wait for a response from TSYS. |
MaxPendingResponseCount | Maximum number of pending response packets. |
DisconnectInterleaved | To explicitly terminate the connection. |
DoEvents | Processes events from the internal message queue. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
LocationDetailName | Merchant name. |
LocationDetailAddress | Merchant's street address. |
LocationDetailCity | Name of the city. |
LocationDetailRegion | Region code that corresponds to the state, province, or other country subdivision. |
LocationDetailCountry | Country code. |
LocationDetailPostal | Postal code. |
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. |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
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). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The TCP port in the local host where the component binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
RecordLength | The length of received data records. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
TcpNoDelay | Whether or not to delay when sending packets. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True. |
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. |