CancelPreApproval Method

Cancels an existing preapproval.

Syntax

adaptivepreapproval.cancelPreApproval(preApprovalKey, [callback])

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 this 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 PreApprovalKey parameter indicates the preapproval to be canceled. You can obtain this key from the PreApprovalKey response property after a successful CreatePreApproval.

No additional properties (beyond PayPal login credentials) are required to use this method.