PreApprovalKey Property

The key associated with a preapproval for this payment.

Syntax

 adaptivepay.getPreApprovalKey([callback])
 adaptivepay.setPreApprovalKey( preApprovalKey, [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

The PreApprovalKey is required if this is a pre-approved payment. Note that preapprovals are not available to API callers with Standard permission levels.

Data Type

String