MaxFailedPayments Property

The max number of failed payments.

Syntax

 recurringpayments.getMaxFailedPayments([callback])
 recurringpayments.setMaxFailedPayments( maxFailedPayments, [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 getMaxFailedPayments([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 setMaxFailedPayments([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

The max number of failed payments that must occur for PayPal to automatically suspend the profile. When this amount of failed payments is reached, an IPN message will be sent to the merchant with a notification that the profile has been suspended.

Data Type

String