MaxTotalPaymentAmount Property

The preapproved maximum total amount of all payments.

Syntax

 adaptivepreapproval.getMaxTotalPaymentAmount([callback])
 adaptivepreapproval.setMaxTotalPaymentAmount( maxTotalPaymentAmount, [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 getMaxTotalPaymentAmount([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 setMaxTotalPaymentAmount([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

It cannot exceed $2,000 USD or its equivalent in other currencies.

This property is required for the CreatePreApproval method.

Data Type

String