2013

SOAP API Developer Reference February 01, 2013 99
ExpressCheckout API Operations
SetExpressCheckout API Operation
6
PaymentDetailsItemType Fields
PaymentAction ebl:PaymentActionCodeType
How you want to obtain payment. When implementing parallel payments, this field
is required and must be set to Order. When implementing digital goods, this field
is required and must be set to Sale. If the transaction does not include a one-time
purchase, this field is ignored. It is one of the following values:
 Sale – This is a final sale for which you are requesting payment (default).
 Authorization – This payment is a basic authorization subject to settlement
with PayPal Authorization and Capture.
 Order – This payment is an order authorization subject to settlement with
PayPal Authorization and Capture.
NOTE: You cannot set this field to Sale in SetExpressCheckout request and
then change the value to
Authorization or Order in the
DoExpressCheckoutPayment request. If you set the field to
Authorization or Order in SetExpressCheckout, you may set the
field to
Sale.
Character length and limitations: Up to 13 single-byte alphabetic characters
PaymentRequestID xs:string
A unique identifier of the specific payment request, which is required for parallel
payments.
Character length and limitations: Up to 127 single-byte characters
Field Description
Name xs:string
Item name. This field is required when you pass a value for ItemCategory.
Character length and limitations: 127 single-byte characters
This field is introduced in version 53.0.
Description xs:string
(Optional) Item description.
Character length and limitations: 127 single-byte characters
This field is introduced in version 53.0.
Amount ebl:BasicAmountType
Cost of item. This field is required when you pass a value for ItemCategory.
NOTE: You must set the currencyID attribute to one of the 3-character currency
codes for any of the supported PayPal currencies.
Character length and limitations: Value is a positive number which cannot exceed
$10,000 USD in any currency. It includes no currency symbol. It must have 2
decimal places, the decimal separator must be a period (.), and the optional
thousands separator must be a comma (,).
This field is introduced in version 53.0.
Field Description