TSYSSettle Control

Properties   Methods   Events   Configuration Settings   Errors  

The TSYSSettle component is used to do a Batch Settlement on all transactions that were successfully authorized with the TSYSECOMMERCE or TSYSRETAIL components. This component may also send Level II and Level III Corporate Purchasing Card data for better interchange rates.

Syntax

TSYSSettle

Remarks

This control allows for a direct, secure connection to the Vital/TSYS 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 TSYSSettle control is used to settle all transactions previously authorized by the TSYSECommerce or TSYSRetail control. When a transaction is authorized, money in the customer's account is blocked and tagged for the merchant. However, funds do not actually change hands at this point. When transactions are settled with the TSYSSettle control the funds are deducted from the customer's account and added to the merchant's. It is essential that the authorized transactions are properly recorded and resent later in a Batch Settlement.

To send a Batch Settlement, first the user must fill out the Merchant properties with the same information contained in the authorizing control's Merchant properties.

  TSYSSettle.MerchantBankId = "999995"
  TSYSSettle.MerchantCategoryCode = "5999"
  TSYSSettle.MerchantName = "test merchant"
  TSYSSettle.MerchantNumber = "123456789012"
  TSYSSettle.MerchantCity = "Beverly Hills"
  TSYSSettle.MerchantState = "CA"
  TSYSSettle.MerchantStoreNumber = "5999"
  TSYSSettle.MerchantTerminalNumber = "1515"
  TSYSSettle.MerchantZip = "90210"

Additionally, the AgentBankNumber, AgentChainNumber, TerminalId, BatchNumber, and IndustryType must be set. Note that the TerminalId is fundamentally different from the MerchantTerminalNumber. The MerchantTerminalNumber is used to identify a unique terminal (PC, server, whatever) within a merchant location. The TerminalId, also known as the "V Number", is used for point-of-sale tracking.

  TSYSSettle.AgentBankNumber = "000000"
  TSYSSettle.AgentChainNumber = "111111"
  TSYSSettle.TerminalId = "00000001"
  TSYSSettle.BatchNumber = 15
  TSYSSettle.IndustryType = itRetail

At this point, you are ready to add transactions to the batch settlement. Each transaction to be settled must be added to the DetailRecordAggregate array property. First set the DetailRecordCount; to the total number of transactions you wish to settle. Each index in the DetailRecordAggregate array property must be set with the XML aggregate returned from the TSYSRetail, TSYSECommerce, or TSYSDetailRecord control's GetDetailAggregate method.

  TSYSSettle.DetailRecordCount = 1
  TSYSSettle.DetailAggregate(0) = TSYSRetail.GetDetailAggregate()

Finally, call the SendSettlement method.

  TSYSSettle.SendSettlement()

If the transaction is successful, the ResponseCode will contain "GB", which indicates a "Good Batch". You should check that the ResponseNetDeposit and ResponseRecordCount match the BatchNetDeposit and BatchRecordCount properties.

If the transaction is not successful and you receive an "RB" ResponseCode (indicating a "Rejected Batch") the control fails with an error. You may inspect the ErrorData. ErrorDataFieldNumber, ErrorRecordType, ErrorSequenceNumber, and ErrorType properties for more information concerning why the batch was rejected. After either fixing this record to resolve the error, or removing the record from the batch, the entire batch must be resubmitted. When resubmitting a batch that was previously rejected, the BatchNumber must be set to the same value that was originally used. It is critical that the same BatchNumber value is used to avoid duplicate charges.

Thousands of detail records may be settled in the above manner, just by increasing the DetailRecordCount and adding a transaction to each index of the DetailRecordAggregate property. However it is recommended that Batch Settlements be kept relatively small - around 100 transactions or so - to decrease the number of records that must be resent in the event of an error.

To Void a transaction that has been authorized but has not yet been settled, simply do not include it in the batch settlement. The block on the cardholder's account will clear automatically. Credits and forced transactions may be created using the TSYSDetailRecord control and settled in the same manner.

To add Level II or Level III data to the settled transactions, use the DetailRecordAddendum property and the TSYSLevel2 or TSYSLevel3 controls.

Note that the IndustryType from the TSYSSettle control MUST match the detail record aggregate of EACH transaction that is added to the settlement. You cannot mix industry types in a batch - you must settle a separate batch for each industry type.