PreApprovalKey Property

Returned from PayPal and used to identify this preapproval.

Syntax

 adaptivepreapproval.getPreApprovalKey([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 getPreApprovalKey([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 setPreApprovalKey([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

Upon a successful CreatePreApproval request, this property will contain a pre-approval key used in the AdaptivePay class to identify this preapproval, and it is used when canceling or retrieving the details of a preapproval using the CancelPreApproval or GetPreApprovalDetails methods.

This property is read-only.

Data Type

String