TSYSHCAdjustment Bean
Properties Methods Events Configuration Settings Errors
The TSYSHCAdjustment component is used to adjust a previously authorized transaction. This component makes adjusting transactions very easy.
Syntax
InPayDirect.Tsyshcadjustment
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 TSYSHCAdjustment component makes adjusting transactions 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 and POS specific properties with setup information acquired from your member bank or processor. For instance:
TSYSHCAdjustment1.GenKey = "gen_key_value" TSYSHCAdjustment1.MerchantId = "merchant_id" TSYSHCAdjustment1.RoutingId = "routing_id"
Next, set properties that contain details about the transaction. At a minimum, you must set a RetrievalNumber and OriginalAmount.
TSYSHCAdjustment1.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCAdjustment1.OriginalAmount = "1250"
If you wish to settle an amount that is different than the original authorized amount, you can set SettleAmount to the value you wish to settle. Note that this value can only be less than or equal to the OriginalAmount.
TSYSHCAdjustment1.SettleAmount = "1000"
Finally, submit the adjustment by calling AdjustTransaction.
TSYSHCAdjustment1.AdjustTransaction()
When the component receives a response from the Vital/TSYS servers, the result of the adjustment will be displayed in several Response properties. The Code indicates whether the transaction adjustment was successful. The remaining properties provide additional information about the transaction.
Once the adjustment details are successfully added, the transaction will be added to the current batch. The transaction must go through the batch settlement process in order for the merchant to receive the funds in his merchant account. This is done automatically via a Scheduled Close Batch event that you have setup on your Host Capture Terminal Profile. Alternatively you can manually close a batch by using the TSYSHCBatchMgr component.
Property List
The following is the full list of the properties of the bean with short descriptions. Click on the links for further details.
CaptureMode | The capture mode to be used when performing an authorization or adjustment. |
ClearingSequenceCount | The total number of installment payments. |
ClearingSequenceNumber | The payment number of the total number of installment payments. |
GenKey | The unique GenKey value used to identify a POS device. |
GoodsIndicator | Used to identify the type of goods purchased over the Internet. |
InvoiceNumber | Invoice number for the purchase. |
Level2 | Level2 Corporate Purchasing Card data. |
MerchantId | The unique ID that associates the POS device with the merchant account. |
OriginalAmount | The original authorized amount for the transaction to be adjusted. |
Response | Contains the response to an adjustment request. |
RetrievalNumber | The retrieval reference number (RRN) used to identify a transaction. |
RoutingId | The Routing ID assigned to the merchant by TSYS. |
SettleAmount | The final settlement amount. |
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. |
TransactionDesc | Soft (Dynamic) Descriptor. |
TransactionNumber | Sequence number of this transaction. |
Method List
The following is the full list of the methods of the bean with short descriptions. Click on the links for further details.
adjustTransaction | Sends an adjustment request. |
config | Sets or retrieves a configuration setting . |
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 bean 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 bean 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. |