TSYSECommerce Component
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
DPayments.DPaymentsSDK.Tsysecommerce
Remarks
This component allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This component can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the component, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
The TSYSECommerce 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, TLS/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 Code indicates whether the transaction was approved, and the AVSResult 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 component. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.
Note: The TSYSECommerce component can be used to pass 3D-Secure and MasterCard SecureCode authentication data in an authorization to achieve a better interchange rate. To send this data, the ECI, XID and CAVV (3D-Secure), UCAFIndicator, UCAFSecurityIndicator and UCAFData (MasterCard SecureCode) configuration variables must be set before calling Authorize. The CAVV and UCAF authentication result code will be returned in the ResponseCAVV and ResponseUCAF configuration settings, respectively. For Mastercard Identity Check transactions you must set the ProgramProtocol and DirectoryServerTxnID configs.
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 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.
Card | Contains the customer's credit card information. |
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. |
Merchant | Contains the merchant's setup information. |
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. |
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. |
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 component with short descriptions. Click on the links for further details.
IsPassengerTransport | Indicates that the transaction is a passenger transport transaction. |
IsExistingDebtPayment | Specifies whether the transaction is a payment on an existing debt transaction. |
IsPurchaseReturnAuthorization | Set this to process a Purchase Return Authorization transaction. |
IsMerchantInitiatedTransaction | Set this to process a Merchant Initiated transaction. |
MITTransactionId | Transaction Id associated with the original authorization of a Merchant Initiated Transaction. |
MessageReasonCode | Code used to identify the Merchant Initiated Transactions for Visa. |
POSEnvironmentIndicator | Provides additional information about the transaction for Visa. |
TransactionStatus | A 1-character value used to indicate the purpose or status of the request (Mastercard and Discover only). |
AcceptanceDeviceType | Identifies the type of device used to accept mPOS transactions (Mastercard only). |
MastercardWalletId | Mastercard Wallet Identifier used to identify the Wallet Provider. |
IncrementalTransId | Transaction Id associated with authorization to increment. |
IncrementalTransDate | Transaction Date associated with authorization to increment. |
IncrementalTransTime | Transaction Time associated with authorization to increment. |
IncrementalApprovalCode | Transaction Approval Code associated with authorization to increment. |
IncrementalRetrievalNumber | Transaction Retrieval Number associated with authorization to increment. |
CumulativeAmount | Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only). |
OriginalAmount | The Original Amount related to a previous Consumer Initiated Transaction (Discover only). |
OriginalAmountAccountType | The Account Type of the Original Amount (Discover only). |
ECI | Electronic Commerce Indicator. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
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. |
IsEstimatedAmount | Specifies whether the amount is an estimate. Visa transactions only. |
AmexCNPInternetPhoneData | Used by Merchants in mail-, telephone- and internet-order industries to submit additional data for Card Not Present transactions. |
AmexAirlinePassengerData | Used by Merchants that are in the airline industry to submit information for Passenger Transport 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/Province Code. |
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. |
CurrentPendingResponseCount | Current number of pending response packets. |
DisconnectInterleaved | To explicitly terminate the connection. |
DoEvents | Processes events from the internal message queue. |
ResponseTransactionIntegrityClass | A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
MerchantSellerID | Merchant's Seller ID. |
LocationDetailName | Merchant name. |
LocationDetailAddress | Merchant's street address. |
LocationDetailPhone | Merchant's phone number. |
LocationDetailEmail | Merchant's e-mail adress. |
LocationDetailCity | Name of the city. |
LocationDetailRegion | Region code that corresponds to the state, province, or other country subdivision. |
LocationDetailCountry | Country code. |
LocationDetailPostal | Postal code. |
AmexAggregatorName | Amex Payment Service Provider/Aggregator Name. |
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. |
TokenRequestorID | Card brand Token Requestor ID assigned by the token service provider. |
CanadaDomesticIndicator | Canada Domestic Indicator. |
DigitalPaymentCryptogram | Digital Payment Cryptogram used for DSRP transactions. |
ProgramProtocol | Identifies the type of 3D-Secure program. |
DirectoryServerTxnID | Directory Server Transaction ID generated by the EMV 3DS Mastercard Directory Server during authentication. |
UCAFIndicator | Indicates the merchant's support and usage of UCAF in MasterCard SecureCode transactions. |
UCAFSecurityIndicator | Indicates the security level and cardholder authentication in MasterCard SecureCode transactions. |
UCAFData | UCAF Authentication data from the MasterCard SecureCode authentication. |
ResponseUCAF | Used for MasterCard SecureCode transactions to indicate whether MasterCard downgraded the SecureCode transaction and sent it to the Issuer. |
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). |
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;. |
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 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. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
TcpNoDelay | Whether or not to delay when sending packets. |
CACertFilePaths | The paths to CA certificate files when using Mono on Unix/Linux. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
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. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
TLS12SupportedGroups | The supported groups for ECC. |
TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
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. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
UseBackgroundThread | Whether threads created by the component are background threads. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |