ResponseToken Property

The time-stamped token value.

Syntax

 expresscheckout.getResponseToken([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 getResponseToken([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 setResponseToken([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 property is returned after all three kinds of Express Checkout requests: SetCheckout. GetCheckoutDetails, and CheckoutPayment. This token is used to reference a specific transaction in the PayPal network.

This value is used for several things:

• After calling the SetCheckout method, the value of this property should be appended to the PayPal login page, located here: https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=. The customer's browser should then be redirected to this location. This starts the PayPal payment process.
• After the customer successfully pays, this token is appended as a query string to the value sent in the ReturnURL property. The customer is redirected to this URL (which should reside on your server).
• You must then pass this value in the Token parameter of the GetCheckoutDetails method to continue the transaction.
• The Token property must be set with this value before calling CheckoutPayment.

This token expires after three hours.

This property is read-only.

Data Type

String