AddCustomField Method

Adds a custom name-value pair to be sent with the next request.

Syntax

recurringpayments.addCustomField(name, value, [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

This method should be used to add a custom name-value pair to be added to the next outgoing request to PayPal.

Note that the added custom fields will be cleared after each request automatically by the class.