GetDetailAggregate Method

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

Syntax

ptechhotel.getDetailAggregate([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method returns an aggregate containing all of the required data to send a transaction to settlement. This is only used when processing on the Terminal Capture System (TCS) and using the PTechManualSettle class Generally, you will only use detail aggregates and manual settlements for the Hotel and Restaurant IndustryTypes.

This aggregate must be passed to the PTechManualSettle class's DetailRecords 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 extra hotel charges for instance), you may use the PTechDetailRecord class 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:

  PTechCharge.Sale();
	PTechManualSettle.DetailRecords[0] = PTechCharge.GetDetailAggregate();