PaymentAction Property

How you want to obtain payment.

Syntax

 expresscheckout.getPaymentAction([callback])
 expresscheckout.setPaymentAction( paymentAction, [callback])

Possible Values

  0 (aSale), 
  1 (aAuthorization), 
  2 (aOrder)

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 getPaymentAction([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 setPaymentAction([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 required when calling the CheckoutPayment method.

This property is required when calling the SetCheckout method.

Possible values of this property include:


Value	Meaning
aSale (0)	Sale means all funds will be automatically deposited in your merchant PayPal account when the transaction is complete.
aAuthorization (1)	An Authorization transaction is used when you wish to authorize a card, but not necessarily transfer the funds yet. For instance, you may wish to authorize the card when a customer orders items through your website, and then settle the transaction once the items actually ship. You may use Capture to settle any outstanding authorizations. Authorizations enable you to capture up to 115% or USD $75 more than the amount you specify when CheckoutPayment is called. Authorizations hold the customer's funds for up to 3 days. The authorization is valid however for 29 days. Authorizations may be reauthorized only once during this period.
aOrder (2)	An Order transaction is very similar to an Authorization transaction, but it may contain more than one authorizations in the 29 day period. The Order transaction cannot be reauthorized, instead you must wait until the authorization period expires. This type of transaction should be used for different types of split orders where there are multiple deliverable times and thus portions of the payment will be made at various times.

Data Type

Integer