Direct Payment Integrator V6 - Online Help
Direct Payment Integrator V6
Questions / Feedback?

TSYSHCTransactionDetails Control

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

TSYSHCTransactionDetails

Remarks

This control allows for simple, direct, secure connection to the Vital/TSYS TLS/SSL gateway through a standard Internet connection. This control can be integrated into web pages or stand-alone Point Of Sale applications. Because all TLS/SSL communications are handled inside the control, any application or web page can be deployed without the need for expensive dedicated TLS/SSL servers.

The TSYSHCTransactionDetails control 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 control 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 control 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 control with short descriptions. Click on the links for further details.

GenKeyThe unique GenKey value used to identify a POS device.
MerchantIdThe unique ID that associates the POS device with the merchant account.
ResponseBatchResponseCodeThis property contains the response code indicating the status of a batch management request.
ResponseBatchResponseTextText information that describes each response code.
ResponseBatchStatusThe current status of the batch in an inquiry.
ResponseCardLast4The last four (4) digits of the customer card number.
ResponseCardLevelResultThis property contains a two-character code created by Visa during the authorization process.
ResponseCardTypeThe type of card sent in the authorization request.
ResponseECIA one-character transaction indicator identifying the type of direct marketing transaction being authorized.
ResponseGoodsIndicatorThe type of goods purchased over the Internet.
ResponseGratuityAmountThe gratuity (tip) amount of the transaction being settled.
ResponseInvoiceNumberThe invoice number assigned by the merchant for a card-not-present purchase.
ResponseNetworkIdThis property contains the identification code of the network on which the transaction was authorized.
ResponsePartialShipmentIndicatorIndicates 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.
ResponsePurchaseIdThe Purchase Order Number supplied by the Visa or MasterCard Purchasing Card cardholder.
ResponseRequestedACIA 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.
ResponseRetrievalNumberThe Retrieval Reference Number from the transaction.
ResponseSettlementAmountThis property contains the final settlement amount of the transaction.
ResponseTrackStatusCodeThis property is used to indicate the magnetic stripe condition and the vulnerability for fraud in Discover Network Card Transactions.
ResponseTransactionAmountThe Transaction Amount from the transaction.
ResponseTransactionFeeTransaction Fee Amount is used in PIN POS transactions to carry the acquirer-assessed surcharge for informational purposes only.
ResponseTransactionNumberThis is the Transaction Original Number (TON) from the transaction.
ResponseTransactionTypeThe original authorization transaction type.
ResponseBatchNumberContains the incrementing ID assigned by TSYS to identify a merchant batch.
ResponseTaxAmountSales tax charged in addition to the original TransactionAmount Any non-zero sales tax must have a minimum value of 0.
ResponseIsTaxExemptIdentifies the characteristics of the amount appearing in TaxAmount and allows you to indicate whether the purchasing card qualifies for tax-exempt status.
ResponseInstallmentAdviceContains the Merchant Advice Code returned by MasterCard MIP.
ResponseCodeIndicates the status of the authorization request.
ResponseApprovalCodeContains an authorization code when a transaction has been approved.
ResponseAVSResultContains the Address Verification System result code.
ResponseCVVResultContains the returned CVV result code if it was requested.
ResponseReturnedACIReturned Authorization Characteristics Indicator contains CPS qualification status.
ResponseTransactionDateLocal transaction date returned from the server in MMddyy format.
ResponseTransactionTimeLocal transaction time returned from the server in HHmmss format.
RetrievalNumberThe retrieval reference number (RRN) used to identify a transaction.
RoutingIdThe Routing ID assigned to the merchant by TSYS.
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf 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.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
TimeoutA timeout for the component.
TransactionNumberSequence number of this transaction.

Method List


The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

ConfigSets or retrieves a configuration setting .
GetDetailsSends a transaction detail inquiry request.
InterruptInterrupts the current action.
ResetClears all properties to their default values.

Event List


The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.

Configuration Settings


The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.

RawRequestReturns the request sent to the server for debugging purposes.
RawResponseReturns the response received from the server for debugging purposes.
ServerURLThe server to which transactions are posted.
LanguageIndicates the language to be used in formatting the authorization response text message.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowIdenticalRedirectURLAllow redirects to the same URL.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe TCP port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
RecordLengthThe length of received data records.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseManagedSecurityAPI is True.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 6.0.6240.0