TSYSRetail Component
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, Auto Rental businesses and Passenger Transport.
Syntax
DPayments.DPaymentsSDK.Tsysretail
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 TSYSRetail component 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 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.MerchantCity = "Beverly Hills" component.MerchantState = "CA" component.MerchantStoreNumber = "5999" component.MerchantTerminalNumber = "1515" component.MerchantZip = "90210"
Next, set properties that contain details about the transaction. At the minimum, you must set a TransactionAmount, TransactionNumber, and IndustryType.
component.TransactionAmount = "100" component.TransactionNumber = 1 component.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.
component.Card.MagneticStripe = "%B4444333322221111^SMITH/JOHN J ^031210100000033301000000008000000?"; component.Card.EntryDataSource = edsTrack1;
Finally, submit the transaction by calling the Authorize method.
When 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.
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. |
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 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.
AcceptanceDeviceType | Identifies the type of device used to accept mobile Point of Sale (mPOS) transactions (Mastercard and Amex only). |
AccountDataSource | Identifies the source of the customer card data entered. |
ACI | Requested Authorization Characteristics Indicator (ACI). |
ActivateTerminal | Authenticates a POS device with TSYS. |
AllowPartialAuths | Indicates whether partial authorizations are to be supported. |
AmexAggregatorName | Amex Payment Service Provider/Aggregator Name. |
AmexAirlinePassengerData | Used by Merchants that are in the airline industry to submit information for Passenger Transport transactions. |
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. |
AuthenticationCode | An alphanumeric code provided to the POS user for input when authenticating a POS device. |
AuthorizationIndicator | The type of authorization request. |
BusinessApplicationId | Business Application Identifier (BAI). Visa only. |
CanadaDomesticIndicator | Canada Domestic Indicator. |
CardholderId | Specifies the method used to verify the identity of the cardholder. |
CashOverAmount | The Cash Over amount requested. |
ChipConditionCode | The condition code of magnetic stripe read transactions of EMV (chip capable) cards. |
CountryCode | Identifies the country where the merchant is located. |
CumulativeAmount | Total cumulative authorized amount for series of Incremental authorization transactions (Visa and Discover only). |
CurrencyCode | Identifies the type of currency used by the merchant. |
CurrentPendingResponseCount | Current number of pending response packets. |
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. |
CVV2Option | Verification code. |
DeactivateTerminal | Deactivates a POS device with TSYS. |
DeviceCode | A 1-character value used to identify the device and type of the merchant submitting the settlement batch. |
DisconnectInterleaved | To explicitly terminate the connection. |
DoEvents | Processes events from the internal message queue. |
DomainServer | Remote domain server indicator. |
EMVData | The EMV Data returned from a Pin Pad after reading an EMV card. |
EMVOnlineKSN | Clear-text Key Sequence Number for EMV Online PIN transactions. |
EMVOnlinePIN | DUKPT DES encrypted PIN block for EMV Online PIN transactions. |
GenKey | A randomly generated string of alphanumeric characters identifying the terminal. |
HeartlandDeviceId | Specifies a device ID to uniquely identify each terminal (card data entry device). |
HeartlandEncryptionMode | Specifies the encryption mode to use in Heartland transactions. |
HeartlandKeyBlock | Specifies the key block used to encrypt the data. |
IncrementalApprovalCode | Transaction Approval Code associated with authorization to increment. |
IncrementalRetrievalNumber | Transaction Retrieval Number associated with authorization to increment. |
IncrementalTransDate | Transaction Date associated with authorization to increment. |
IncrementalTransId | Transaction Id associated with authorization to increment. |
IncrementalTransTime | Transaction Time associated with authorization to increment. |
InterleavedMode | Determines whether to use Interleaved Transaction Mode for authorization requests. |
InterleavedTimeout | Timeout value to wait for a response from TSYS. |
IsBalanceInquiry | Indicates that the transaction is a Balance Inquiry transaction. |
IsBillPayment | Indicates that the transaction is a bill payment transaction. |
IsEstimatedAmount | Specifies whether the amount is an estimate. Visa transactions only. |
IsExistingDebtPayment | Specifies whether the transaction is a payment on an existing debt transaction. |
IsMerchantInitiatedTransaction | Set this to process a Merchant Initiated transaction. |
IsPurchaseReturnAuthorization | Set this to process a Purchase Return Authorization transaction. |
IsQuasiCash | Specifies whether the transaction is Quasi-Cash transaction. |
LaneId | Identifies a terminal at the card acceptor location of acquiring institutions or merchant POS systems. |
LocationDetailAddress | Merchant's street address. |
LocationDetailCity | Name of the city. |
LocationDetailCountry | Country code. |
LocationDetailEmail | Merchant's e-mail adress. |
LocationDetailName | Merchant name. |
LocationDetailPhone | Merchant's phone number. |
LocationDetailPostal | Postal code. |
LocationDetailRegion | Region code that corresponds to the state, province, or other country subdivision. |
MastercardWalletId | Mastercard Wallet Identifier used to identify the Wallet Provider. |
MaxPendingResponseCount | Maximum number of pending response packets. |
MerchantLanguage | Designates the language that response messages will be returned in. |
MerchantSellerID | Merchant's Seller ID. |
MessageReasonCode | Code used to identify MIT or Deferred Authorizations for Visa. |
MITTransactionId | Transaction Id associated with the original authorization of a Merchant Initiated Transaction. |
MobileDeviceType | Identifies the type of mobile device used by the cardholder to initiate the transaction. |
MSDI | Market Specific Data Indicator. |
OriginalAmount | The Original Amount related to a previous Consumer Initiated Transaction (Discover only). |
OriginalAmountAccountType | The Account Type of the Original Amount (Discover only). |
PFIdentifier | The Payment Facilitator Identifier value assigned by MasterCard. |
PFNameSubMerchantName | The Payment Facilitator Name and Sub-Merchant name. |
PFSubMerchantCity | The Payment Facilitator Sub-Merchant City. |
PFSubMerchantCountry | The Payment Facilitator Sub-Merchant Country Code. |
PFSubMerchantIdentifier | The Payment Facilitator Sub-Merchant Identifier. |
PFSubMerchantPostalCode | The Payment Facilitator Sub-Merchant Postal Code. |
PFSubMerchantState | The Payment Facilitator Sub-Merchant State/Province Code. |
Port | The port to which transactions are posted. |
POSDataCode | Specifies the condition of the POS device used at the time of the transaction. |
POSEnvironmentIndicator | Provides additional information about the transaction for Visa. |
Processor | Specifies the Processor you are connecting to. |
RequestToken | Indicates whether to request a token for the specified card data sent in an Authorize request. |
ResponseAvailableBalance | Response Available Balance. |
ResponseCardholderVerification | Verification results for cardholder identification data (extended AVS). |
ResponseCashOverAmount | The Cash Over amount approved. |
ResponseEMVData | The EMV Data returned in an authorization response. |
ResponseLedgerBalance | Response Ledger Balance. |
ResponseMerchantAdviceCode | The Merchant Advice Code returned by Mastercard MIP for declined CNP transactions. |
ResponseStoreNumber | Check this field against the original Merchant StoreNumber. |
ResponseTerminalNumber | Check this field against the original Merchant TerminalNumber. |
ResponseTokenStatus | The status of retrieval of the token. |
ResponseTransactionIntegrityClass | A 2-character value returned in the response of MasterCard Credit transactions to identify the transaction integrity class. |
RetailDepartmentName | Department name. |
RetrieveToken | Sends a Token Only request. |
Retry | Set this to retry a failed transaction. |
SendCommCardInd | Indicates whether to send Commercial Card Request Indicator. |
SendExtendedAVS | Specifies whether to send extended AVS data. |
Server | The server to which transactions are posted. |
SurchargeAmount | The transaction fee amount charged to the customer to account for acquirer-assessed surcharge. |
Token | The token received from the TSYS host when a token request is sent. |
TransactionStatus | A 1-character value used to indicate the purpose or status of the request. |
TsysETB | The Encryption Transmission Block TSYS uses to decrypt encrypted data. |
CloseStreamAfterTransfer | If true, the component will close the upload or download stream after the transfer. |
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. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
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. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
UseNTLMv2 | Whether to use NTLM V2. |
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. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedProtocol | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
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. |
TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
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. |
BuildInfo | Information about the product's build. |
GUIAvailable | Tells the component whether or not a message loop is available for processing events. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |