TSYSTerminalMgr Class
Properties Methods Events Configuration Settings Errors
The TSYSTerminalMgr component is used to authenticate and deactivate POS devices on the TSYS Terminal Capture platform.
Class Name
InPayDirect_TSYSTerminalMgr
Procedural Interface
inpaydirect_tsysterminalmgr_open(); inpaydirect_tsysterminalmgr_close($res); inpaydirect_tsysterminalmgr_register_callback($res, $id, $function); inpaydirect_tsysterminalmgr_get_last_error($res); inpaydirect_tsysterminalmgr_get_last_error_code($res); inpaydirect_tsysterminalmgr_set($res, $id, $index, $value); inpaydirect_tsysterminalmgr_get($res, $id, $index); inpaydirect_tsysterminalmgr_do_authenticatedevice($res); inpaydirect_tsysterminalmgr_do_config($res, $configurationstring); inpaydirect_tsysterminalmgr_do_deactivatedevice($res); inpaydirect_tsysterminalmgr_do_interrupt($res); inpaydirect_tsysterminalmgr_do_reset($res);
Remarks
The TSYSTerminalMgr class makes authenticating and deactivating terminals simple. Terminal authentication can help reduce fraud risk and is recommended. Before authenticationg a device an AuthenticationCode must be obtained from TSYS. Provide the AuthenticationCode and other merchant information when calling AuthenticateDevice to obtain a GenKey.
Once the GenKey is obtained include this in all transactions from the terminal. When processing transactions
using other components the GenKey may be specified via the Config method. For example:
TSYSRetail1.Config("GenKey=MY_GEN_KEY");
To deactivate a terminal set GenKey and call DeactivateDevice.
Authenticating a Terminal
AuthenticateDevice authenticates a POS device with TSYS. After a device is authenticated GenKey will hold a unique value that should be included in all future transaction requests from the terminal. Before calling this method an AuthenticationCode must be obtained from TSYS.
The following Merchant properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode to determine if the authentication succeeded. If the authentication succeeded ResponseCode will be "A1" and GenKey will be populated. If authentication failed ResponseCode will be "A2".
In addition to GenKey the following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
TSYSTerminalMgr1.Merchant.BankId = "999999"; TSYSTerminalMgr1.Merchant.CategoryCode = "9999"; TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT"; TSYSTerminalMgr1.Merchant.Number = "888000002447"; TSYSTerminalMgr1.Merchant.StoreNumber = "5999"; TSYSTerminalMgr1.Merchant.TerminalNumber = "1234"; TSYSTerminalMgr1.Merchant.Zip = "27516"; TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807"; TSYSTerminalMgr1.TransactionNumber = 1234; TSYSTerminalMgr1.AuthenticationCode = "N123456789"; TSYSTerminalMgr1.AuthenticateDevice(); string genkey = ""; if (TSYSTerminalMgr1.Response.Code == "A1") //approved genkey = TSYSTerminalMgr1.GenKey;
Processing Transactions
When processing transactions with other components in the toolkit smply set the "GenKey" configuration setting.
For instance:
TSYSRetail1.TransactionAmount = "1200"; TSYSRetail1.TransactionNumber = 2345; TSYSRetail1.IndustryType = TsysretailIndustryTypes.sitRetail; TSYSRetail1.Card.EntryDataSource = EntryDataSources.edsTrack1; TSYSRetail1.Card.MagneticStripe = "B4444333322221111^DOE/JOHN E ^091210100000033301000000008000000"; TSYSRetail1.Config("GenKey=" + genkey); TSYSRetail1.Authorize();
Deactivating a Terminal
DeactivateDevice is used to deactivate a previously activated terminal identified by GenKey.
The following Merchant properties are applicable when calling this method:
- MerchantBankId
- MerchantCategoryCode
- MerchantCountryCode
- MerchantCurrencyCode
- MerchantLanguage
- MerchantNumber
- MerchantServicePhone
- MerchantStoreNumber
- MerchantTerminalNumber
- MerchantTimeZone
- MerchantZip
After calling this method check ResponseCode and confirm it is "A3" to indicate the deactivation succeeded. The following Response properties are populated:
- ResponseCode
- ResponseTransactionDate
- ResponseTransactionNumber
- ResponseTransactionTime
- ResponseAuthSource
- ResponseText
DeactivateDevice Example:
TSYSTerminalMgr1.Merchant.BankId = "999999"; TSYSTerminalMgr1.Merchant.CategoryCode = "9999"; TSYSTerminalMgr1.Merchant.Name = "TESTMERCHANT"; TSYSTerminalMgr1.Merchant.Number = "888000002447"; TSYSTerminalMgr1.Merchant.StoreNumber = "5999"; TSYSTerminalMgr1.Merchant.TerminalNumber = "1234"; TSYSTerminalMgr1.Merchant.Zip = "27516"; TSYSTerminalMgr1.Merchant.ServicePhone = "6023337807"; TSYSTerminalMgr1.TransactionNumber = 1234; TSYSTerminalMgr1.GenKey = "MY_GEN_KEY"; TSYSTerminalMgr1.DeactivateDevice(); if (TSYSTerminalMgr1.Response.Code == "A3") //deactivated //...
Property List
The following is the full list of the properties of the class with short descriptions. Click on the links for further details.
AuthenticationCode | An alphanumeric code used during the POS device authentication process. |
GenKey | A random alphanumeric value returned by TSYS. |
IndustryType | Code which indicates the industry the merchant is engaged in. |
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. |
TransactionNumber | Sequence number of this transaction. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
AuthenticateDevice | Authenticates a POS terminal. |
Config | Sets or retrieves a configuration setting . |
DeactivateDevice | Deactivates a POS terminal. |
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 class 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. |
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 class with short descriptions. Click on the links for further details.
Port | The port to which transactions are posted. |
Server | The server to which transactions are posted. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowIdenticalRedirectURL | Allow redirects to the same URL. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
EncodeURL | If set to true the URL will be encoded by the component. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the component will perform a GET on the new location. |
HTTPVersion | The version of HTTP used by the component. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the component. |
TransferredHeaders | The full set of headers as received from the server. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
UserAgent | Information about the user agent (browser). |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
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. |