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

TSYSHCBatchMgr Control

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSHCBatchMgr component is used to manually close batches as well as retrieve details and summaries about batches. This component makes closing batches very easy.

Syntax

TSYSHCBatchMgr

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 TSYSHCBatchMgr control makes closing batches 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 authorizing a transaction are outlined below:

First, set the merchant and POS specific properties with setup information acquired from your member bank or processor. For instance:


  TSYSHCBatchMgr1.GenKey = "gen_key_value"
  TSYSHCBatchMgr1.MerchantId = "merchant_id"
  TSYSHCBatchMgr1.RoutingId = "routing_id"

Next, set BatchNumber to the batch number you wish to close or retrieve details about.


  TSYSHCBatchMgr1.BatchNumber = 1

Finally, submit the transaction by calling one of three authorization methods: CloseBatch, GetDetails, or GetSummary. The following code demonstrates closing a batch:


  TSYSHCBatchMgr1.CloseBatch()

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.

BatchNumberThe batch number to close or retrieve details about.
DetailResultCountThe number of records in the DetailResult arrays.
DetailResultCardLast4The last four (4) digits of the customer card number.
DetailResultCardTypeThe type of card sent in the authorization request.
DetailResultRetrievalNumberThe Retrieval Reference Number from the transaction.
DetailResultSettlementAmountThis property contains the final settlement amount of the transaction.
DetailResultTransactionAmountThe Transaction Amount from the transaction.
DetailResultTransactionTypeThe original authorization transaction type.
DetailResultTransactionNumberThis is the Transaction Original Number (TON) from the transaction.
GenKeyThe unique GenKey value used to identify a POS device.
MerchantIdThe unique ID that associates the POS device with the merchant account.
PendingTransactionCountThe number of transactions that will not be captured in the current batch.
ResponseBatchNumberContains the incrementing ID assigned by TSYS to identify a merchant batch.
ResponseCloseDateThe date that the batch was closed (in MMDDYY format).
ResponseCloseTimeThe time that the batch was closed (in HHMMSS format).
ResponseCodeIndicates the status of the close batch request.
ResponseStatusThe current status of the batch in an inquiry.
ResponseTextText information that describes each response code.
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).
SummaryResultCountThe number of records in the SummaryResult arrays.
SummaryResultNetAmountThis is the net amount total for the particular summary type in the batch.
SummaryResultPurchaseCountThe total count for the particular summary type of all purchases in the batch.
SummaryResultRefundCountThe total count for the particular summary type of all refunds in the batch.
SummaryResultTypeThis is the type of summary being provided in the Batch Summary Inquiry.
TimeoutA timeout for the component.

Method List


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

CloseBatchSends a batch close request.
ConfigSets or retrieves a configuration setting .
GetDetailsSends a batch detail inquiry request.
GetSummarySends a batch summary 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.

RequestedTransactionCountSpecifies the number of transactions to return in a GetDetails request.
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