Note Property

The reason for the current action.

Syntax

 recurringpayments.getNote([callback])
 recurringpayments.setNote( note, [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 getNote([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 setNote([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

This is an optional property that is used when modifying a current profile. It contains the reason for why the particular action was taken in regards to the account.

The Note will be included in email notification sent to the buyer associated with the recurring payments account. It will also be viewable by the merchant and buyer on the Status History page of the PayPal account.

Data Type

String