TSYSRetail Bean
Properties Methods Events Configuration Settings Errors
The TSYSRetail 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.
Syntax
InPayDirect.Tsysretail
Remarks
This bean allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This bean can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the bean, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.
The TSYSRetail bean 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, TLS/SSL handshakes, or data packet formatting. The steps to setting up the bean and authorizing a transaction are outlined below:
First, set the merchant properties with setup information acquired from your member bank or processor. For instance:
bean.MerchantBankId = "999995" '(BIN number) bean.MerchantCategoryCode = "5999" bean.MerchantName = "test merchant" bean.MerchantNumber = "123456789012" bean.MerchantCity = "Beverly Hills" bean.MerchantState = "CA" bean.MerchantStoreNumber = "5999" bean.MerchantTerminalNumber = "1515" bean.MerchantZip = "90210"
Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount, TransactionNumber, and IndustryType.
bean.TransactionAmount = "100" bean.TransactionNumber = 1 bean.IndustryType = itRetail
Now, set the credit card properties. If available, you should use Track1 data. Some cards may have a corrupt or missing track1, and for these cards you may use track2 data. If the card is not readable, you may also manually enter the card number and expiration date. The following example shows a transaction sent with track1 data.
bean.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?"; bean.Card.EntryDataSource = edsTrack1;
Finally, submit the transaction by calling the Authorize method.
When the bean 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 bean. Usually, a Batch Settlement of all authorized transactions is done at the end of each business day.
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
Card | Contains the customer's credit card information. |
CardPresent | Indicates whether the current transaction is a card present transaction. |
CustomerAddress | The customer's billing address. |
CustomerZip | Customer's zip code (or postal code if outside of the USA). |
IndustryType | Code which indicates the industry the merchant is engaged in. |
Merchant | Contains the merchant's setup information. |
PrestigiousIndicator | Prestigious Lodging Program indicator for the Hotel Industry Type. |
RentalDuration | Duration of an auto rental or hotel stay. |
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. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
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 bean 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 bean with short descriptions. Click on the links for further details.
AccountDataSource | Identifies the source of the customer card data entered. |
CVV2Option | Verification code. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
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. |
DeviceCode | A 1-character value used to identify the device and type of the merchant submitting the settlement batch. |
IncrementalTransId | Transaction Id associated with authorization to increment. |
CashOverAmount | The Cash Over amount requested. |
ResponseCashOverAmount | The Cash Over amount approved. |
IsQuasiCash | Specifies whether the transaction is Quasi-Cash transaction. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
ChipConditionCode | The condition code of magnetic stripe read transactions of EMV (chip capable) cards. |
EMVData | The EMV Data returned from a Pin Pad after reading an EMV card. |
ResponseEMVData | The EMV Data returned in an authorization response. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
RetailDepartmentName | Department name. |
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. |
MobileDeviceType | Identifies the type of mobile device used by the cardholder to initiate the transaction. |
LaneId | Identifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems. |
DomainSever | Remote domain server indicator. |
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. |
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. |