ReverseOnError Property

Indicates whether to reverse all parallel payments if an error is encountered.

Syntax

 adaptivepay.getReverseOnError([callback])
 adaptivepay.setReverseOnError( reverseOnError, [callback])

Default Value

TRUE

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 getReverseOnError([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 setReverseOnError([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

With parallel payments, fund transfers to some receivers may occur before others. If you set this property to True, in the event of an error transfers to all receivers are reversed and all funds are returned to the sender. If ReverseOnError is set to False, completed transfers are not reversed and funds that have already been transferred are no longer available to the sender.

Data Type

Boolean