CheckoutPayment Method

Either obtain payment for a final sale, or request authorization for later capture of payment.

Syntax

expresscheckout.checkoutPayment([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 completes the sale or authorization. When this method is called, the following properties are required in the request:

• Token
• PaymentAction
• OrderTotal
• PayerId (returned after a call to GetCheckoutDetails)

To obtain payment for a final sale you will have to set the PaymentAction property to aSale. If you want to request an authorization, the PaymentAction property has to be set to aAuthorization. Then, you will need to use Capture to capture the transaction.

The following information may be optionally provided in the request:

• OrderDescription
• Custom (Config setting)
• InvoiceNumber
• NotifyURL (Config setting)
• Payment item details (ItemAmount, ItemName, ItemNumber, ItemQuantity, ItemSalesTax)

The Response and Payment properties may be returned in the response.