TSYSHCTransactionDetails Component
Properties Methods Events Configuration Settings Errors
The TSYSHCTransactionDetails component is used to retrieve details about authorized transactions. This component makes retrieving transaction details very easy.
Syntax
TibcTSYSHCTransactionDetails
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 TSYSHCTransactionDetails component makes retrieving transaction details 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 retrieving transaction details are outlined below:
First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:
TSYSHCTransactionDetails1.GenKey = "gen_key_value" TSYSHCTransactionDetails1.MerchantId = "merchant_id" TSYSHCTransactionDetails1.RoutingId = "routing_id"
Next, set RetrievalNumber to the retrieval number of the transaction you wish to retrieve details about.
TSYSHCTransactionDetails1.RetrievalNumber = "125622902129"
Finally, submit the transaction by calling one the GetDetails method. The following code demonstrates retrieving transaction details:
TSYSHCTransactionDetails1.GetDetails()
When the component 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. The remaining properties provide additional information about the transaction.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
GenKey | The unique GenKey value used to identify a POS device. |
MerchantId | The unique ID that associates the POS device with the merchant account. |
ResponseBatchResponseCode | This property contains the response code indicating the status of a batch management request. |
ResponseBatchResponseText | Text information that describes each response code. |
ResponseBatchStatus | The current status of the batch in an inquiry. |
ResponseCardLast4 | The last four (4) digits of the customer card number. |
ResponseCardLevelResult | This property contains a two-character code created by Visa during the authorization process. |
ResponseCardType | The type of card sent in the authorization request. |
ResponseECI | A one-character transaction indicator identifying the type of direct marketing transaction being authorized. |
ResponseGoodsIndicator | The type of goods purchased over the Internet. |
ResponseGratuityAmount | The gratuity (tip) amount of the transaction being settled. |
ResponseInvoiceNumber | The invoice number assigned by the merchant for a card-not-present purchase. |
ResponseNetworkId | This property contains the identification code of the network on which the transaction was authorized. |
ResponsePartialShipmentIndicator | Indicates whether the merchant or acquirer is awaiting shipment of a portion of the goods purchased in a card transaction prior to submitting the related sales data. |
ResponsePurchaseId | The Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder. |
ResponseRequestedACI | A one-character property containing the Requested ACI used to identify an authorization request as potentially qualifying for CPS (Custom Payment Services) and MasterCard Merit programs. |
ResponseRetrievalNumber | The Retrieval Reference Number from the transaction. |
ResponseSettlementAmount | This property contains the final settlement amount of the transaction. |
ResponseTrackStatusCode | This property is used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions. |
ResponseTransactionAmount | The Transaction Amount from the transaction. |
ResponseTransactionFee | Transaction Fee Amount is used in PIN POS transactions to carry the acquirer-assessed surcharge for informational purposes only. |
ResponseTransactionNumber | This is the Transaction Original Number (TON) from the transaction. |
ResponseTransactionType | The original authorization transaction type. |
ResponseBatchNumber | Contains the incrementing ID assigned by TSYS to identify a merchant batch. |
ResponseTaxAmount | Sales tax charged in addition to the original TransactionAmount Any non-zero sales tax must have a minimum value of 0. |
ResponseIsTaxExempt | Identifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status. |
ResponseInstallmentAdvice | Contains the Merchant Advice Code returned by MasterCard MIP. |
ResponseCode | Indicates the status of the authorization request. |
ResponseApprovalCode | Contains an authorization code when a transaction has been approved. |
ResponseAVSResult | Contains the Address Verification System result code. |
ResponseCVVResult | Contains the returned CVV result code if it was requested. |
ResponseReturnedACI | Returned Authorization Characteristics Indicator contains CPS qualification status. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
RetrievalNumber | The retrieval reference number (RRN) used to identify a transaction. |
RoutingId | The Routing ID assigned to the merchant by TSYS. |
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 component with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting . |
GetDetails | Sends a transaction detail inquiry request. |
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.
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 component with short descriptions. Click on the links for further details.
RawRequest | Returns the request sent to the server for debugging purposes. |
RawResponse | Returns the response received from the server for debugging purposes. |
ServerURL | The server to which transactions are posted. |
Language | Indicates the language to be used in formatting the authorization response text message. |
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. |