TSYSHCLevel3 Component
Properties Methods Events Configuration Settings Errors
The TSYSHCLevel3 component is used to add Level 3 data to a previously authorized transaction. This component makes adding Level 3 data very easy.
Syntax
TibcTSYSHCLevel3
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 TSYSHCLevel3 component makes adding Level 3 data to a transaction 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:
TSYSHCLevel31.GenKey = "gen_key_value" TSYSHCLevel31.MerchantId = "merchant_id" TSYSHCLevel31.RoutingId = "routing_id"
Next, set properties that contain details about the transaction. At the minimum, you must set a RetrievalNumber and OriginalAmount.
TSYSHCLevel31.RetrievalNumber = TSYSHCRetail1.ResponseRetrievalNumber TSYSHCLevel31.OriginalAmount = TSYSHCRetail1.TransactionAmount
Now, set the Level 3 enhanced data that you wish to add to the transaction. For example:
TSYSHCLevel31.CommodityCode = "FAKE" TSYSHCLevel31.NationalTax = "0" TSYSHCLevel31.MerchantTaxId = "merchantTaxId" TSYSHCLevel31.CustomerTaxId = "customerTaxId" TSYSHCLevel31.DiscountAmount = "0" TSYSHCLevel31.FreightAmount = "0" TSYSHCLevel31.DutyAmount = "0" TSYSHCLevel31.ShipFromZip = "27709" TSYSHCLevel31.DestinationZip = "27709" TSYSHCLevel31.DestinationCountry = "840" TSYSHCLevel31.InvoiceNumber = "VATInvoiceRefNo" TSYSHCLevel31.OrderDate = "111023" // "yyMMdd" TSYSHCLevel31.FreightTaxAmount = "0" TSYSHCLevel31.FreightTaxRate = "0"
If you have any line item details, you can specify them now. Note that LineItemQuantity and LineItemTotal are required to be set when adding line item details.
TSYSHCLevel31.LineItemCount = 2 TSYSHCLevel31.LineItemCommodityCode(0) = "fake" TSYSHCLevel31.LineItemDescription(0) = "hardware" TSYSHCLevel31.LineItemDiscountAmount(0) = "0" TSYSHCLevel31.LineItemDiscountRate(0) = "0" TSYSHCLevel31.LineItemProductCode(0) = "1243320" TSYSHCLevel31.LineItemQuantity(0) = 1 TSYSHCLevel31.LineItemTaxAmount(0) = "3" TSYSHCLevel31.LineItemTaxRate(0) = "0" TSYSHCLevel31.LineItemTotal(0) = "53" TSYSHCLevel31.LineItemUnitCost(0) = "50" TSYSHCLevel31.LineItemUnits(0) = "each" TSYSHCLevel31.LineItemCommodityCode(1) = "fake" TSYSHCLevel31.LineItemDescription(1) = "software" TSYSHCLevel31.LineItemDiscountAmount(1) = "0" TSYSHCLevel31.LineItemDiscountRate(1) = "0" TSYSHCLevel31.LineItemProductCode(1) = "1243321" TSYSHCLevel31.LineItemQuantity(1) = 2 TSYSHCLevel31.LineItemTaxAmount(1) = "3" TSYSHCLevel31.LineItemTaxRate(1) = "0" TSYSHCLevel31.LineItemTotal(1) = "106" TSYSHCLevel31.LineItemUnitCost(1) = "53" TSYSHCLevel31.LineItemUnits(1) = "each"
Finally, submit the level 3 details by calling AdjustTransaction.
TSYSHCRetail1.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 ResponseCode indicates whether the level 3 details were successfully added to the transaction. The remaining properties provide additional information about the transaction.
Once the level 3 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.
Note: If you intend to add Level 3 data to a transaction, the initial authorization (purchase) should have CaptureMode set to Delay (1). This initiates a delay on the capture, thus providing you with time to add the Level 3 details before the transaction is settled.
Property List
The following is the full list of the properties of the component with short descriptions. Click on the links for further details.
AlternateTaxAmount | Secondary tax amount (only applicable in some countries). |
AlternateTaxId | Tax Id number of the merchant that reported the AlternateTaxAmount . |
CardType | The card type for which a Level 3 addendum will be created. |
CommodityCode | Code indicating the type of goods or services sold. |
CustomerTaxId | Customer's Value Added Tax registration number. |
DestinationCountry | Country the goods are to be shipped to. |
DestinationZip | Zip code the goods are to be shipped to. |
DiscountAmount | Amount of any discount subtracted from the line item totals. |
DutyAmount | Duty fees (if any) for imported goods. |
FreightAmount | Shipping charges associated with this transaction. |
FreightTaxAmount | Portion of the FreightAmount that is tax. |
FreightTaxRate | Rate used to calculate the FreightTaxAmount . |
GenKey | The unique GenKey value used to identify a POS device. |
LineItemCount | The number of records in the LineItem arrays. |
LineItemCommodityCode | Code describing the good or service being supplied. |
LineItemDescription | Description of the item. |
LineItemDiscountAmount | Amount of the discount for each line item (if any). |
LineItemDiscountRate | Rate used to calculate the DiscountAmount . |
LineItemProductCode | Merchant-defined product code for this Line Item. |
LineItemQuantity | Quantity of items in this Line Item. |
LineItemTaxAmount | Tax on this individual item. |
LineItemTaxIncluded | Net/Gross Indicator. |
LineItemTaxRate | Tax rate used to calculate the TaxAmount . |
LineItemTaxType | Type of tax charged in TaxAmount . |
LineItemTotal | Total cost of this line item. |
LineItemUnitCost | Cost of each individual item. |
LineItemUnits | Unit of measure for this Line Item. |
MerchantId | The unique ID that associates the POS device with the merchant account. |
MerchantTaxId | Merchant's government tax Id number. |
NationalTax | Amount of federal or national taxes that are a part of this transaction. |
OrderDate | Date of the order in YYMMDD format. |
OriginalAmount | The original authorized amount for the transaction to be adjusted. |
ResponseBatchNumber | Contains the incrementing ID assigned by TSYS to identify a merchant batch. |
ResponseRetrievalNumber | This number is to be used to identify transactions and should be submitted when making adjustments, reversals or at settlement. |
ResponseTransactionDate | Local transaction date returned from the server in MMddyy format. |
ResponseTransactionTime | Local transaction time returned from the server in HHmmss format. |
ResponseTransactionNumber | Check this property against the original Transaction Number. |
ResponseText | Text information that describes each response code. |
ResponseCode | Indicates the status of the authorization request. |
RetrievalNumber | The retrieval reference number (RRN) used to identify a transaction. |
RoutingId | The Routing ID assigned to the merchant by TSYS. |
ShipFromZip | Zip code the goods are being shipped from. |
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). |
TaxInvoiceNumber | Optional VAT Invoice Number assigned by the merchant. |
Timeout | A timeout for the component. |
Method List
The following is the full list of the methods of the component with short descriptions. Click on the links for further details.
AdjustTransaction | Sends Level 3 transaction requests. |
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 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. |