MaxPaymentsPerPeriod Property

The preapproved maximum number of all payments per period.

Syntax

 adaptivepreapproval.getMaxPaymentsPerPeriod([callback])
 adaptivepreapproval.setMaxPaymentsPerPeriod( maxPaymentsPerPeriod, [callback])

Default Value

0

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 getMaxPaymentsPerPeriod([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 setMaxPaymentsPerPeriod([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

This may not exceed number of MaxPayments

Data Type

Integer