VoidTransaction Property

Indicates whether this transaction has been voided.

Syntax

 tsysdetailrecord.getVoidTransaction([callback])
 tsysdetailrecord.setVoidTransaction( voidTransaction, [callback])

Default Value

FALSE

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 the getVoidTransaction([callback]) 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.

The callback for the setVoidTransaction([callback]) method is defined as:

function(err){ }

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

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

If you wish to void a previously authorized transaction, Vital/TSYS recommends that you should exclude it from the settlement. However, you may also send the detail record with the VoidTransaction indicator set to True. For example:

  DetailRecord.ParseAggregate(TSYSRetail.GetDetailAggregate())
  DetailRecord.VoidTransaction = True
  TSYSSettle.DetailRecordCount = 1
  TSYSSettle.DetailAggregate[0] = DetailRecord.GetDetailAggregate()

Data Type

Boolean