GetDetailAggregate Method

Returns an aggregate containing details of this transaction, which is then used for settlement.

Syntax

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This aggregate must be passed to the TSYSSettle control's DetailAggregate array property in order to settle the transaction. If you wish to view or change any part of the aggregate (such as adding a gratuity or additional info for an Installment payment), you may use the TSYSDetailRecord control to do so.

Note: This method may only be called after a successful authorization. If the authorization was not successful the method fails with an error.

An example of how this method is used is shown below:

	TSYSRetail.Authorize()
	TSYSSettle.DetailRecordCount = 1    
	TSYSSettle.DetailAggregate[0] = TSYSRetail.GetDetailAggregate()

To settle a transaction authorized with the ttInstallment TransactionType, you must use the TSYSDetailRecord control to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

  TSYSECommerce.TransactionType = ttInstallment
  TSYSECommerce.TransactionAmount = "1995"
  TSYSECommerce.Authorize()

  DetailRecord.ParseAggregate TSYSECommerce.GetDetailAggregate()
  DetailRecord.InstallmentCount = 3
  DetailRecord.InstallmentNumber = 1
  
  TSYSSettle.DetailAggregate[5] = DetailRecord.GetDetailAggregate()