PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

OrderTotal Property

The total cost of the order to the customer.

Syntax

 expresscheckout.getOrderTotal([callback])
 expresscheckout.setOrderTotal( orderTotal, [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 getOrderTotal([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 setOrderTotal([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 shipping cost and tax charges are known, those should included in the OrderTotal if not, the value of this property is the current sub-total of the order.

This property is required when calling the CheckoutPayment method.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

Data Type

String

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0