Download PayPal SOAP API Developer - 2012 Reference Manual

Recurring Payments and Reference Transactions API Operations
DoReferenceTransaction API Operation
Field
Description
ShipToAddress
ns:AddressType
(Optional) Address the order is shipped to.
PaymentDetailsItem
ebl:PaymentDetailsItemType
(Optional) Details about each individual item included in the order.
Recurring
ns:RecurringFlagType
(Optional) Flag to indicate a recurring transaction. It is one of the following values:
 Any value other than Y – This is not a recurring transaction (default).
 Y – This is a recurring transaction.
NOTE:
12
To pass Y in this field, you must have established a billing agreement with the
buyer specifying the amount, frequency, and duration of the recurring
payment.
This field is introduced in version 80.0 of the API.
PaymentDetailsItemType Fields
Field
Description
ItemCategory
ns:ItemCategoryType
Indicates whether the item is digital or physical. For digital goods, this field is
required and you must set it to Digital to get the best rates. It is one of the
following values:
 Digital
 Physical
This field is introduced in version 69.0.
Name
xs:string
Item name. This field is required when you pass a value for ItemCategory.
Character length and limitations: 127 single-byte characters
Description
xs:string
(Optional) Item description.
This field is available since version 53.0.
Character length and limitations: 127 single-byte characters
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 (,).
SOAP API Developer Reference
August 2012
261