RetrievalNumberToVoid Property

Indicates the transaction to void.

Syntax

 ptechcanadiandebit.getRetrievalNumberToVoid([callback])
 ptechcanadiandebit.setRetrievalNumberToVoid( retrievalNumberToVoid, [callback])

Default Value

""

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 getRetrievalNumberToVoid([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 setRetrievalNumberToVoid([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

When sending a transaction with the InteracTransactionType set to ittVoidSale or ittVoidReturn, this property must contain the ResponseRetrievalNumber from the transaction you wish to void. The LastRetrievalNumber is also required for void transactions, and must be set with the LAST ResponseRetrievalNumber received from the Paymentech Server. If LastRetrievalNumber is left blank, the current contents of the ResponseRetrievalNumber property will be used instead.

Data Type

String