CancelURL Property

URL to which the customer is returned if he decides not to pay with PayPal.

Syntax

 expresscheckout.getCancelURL([callback])
 expresscheckout.setCancelURL( cancelURL, [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 getCancelURL([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 setCancelURL([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

If the user starts to pay with PayPal, and then changes his mind, his browser will be redirected to this URL on your server. This may be set to the original page on which the customer chose his payment method.

This property is required when calling the SetCheckout method.

Character length and limitations: no limit. Must be URL-encoded.

Data Type

String