PaymentKey Property

Token returned by Paypal, used to identify the transaction.

Syntax

 adaptivepay.getPaymentKey([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 getPaymentKey([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 setPaymentKey([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 PaymentKey is a token you use in other Adaptive Payment classs (such as the AdaptiveRefund class) to identify this payment. The PaymentKey is valid for 3 hours; the payment must be approved while the PaymentKey is valid.

This property is read-only.

Data Type

String