| Property |
Type |
Description |
|
| $AllowedPaymentMethod |
string |
Allowed payment methods for this transaction. |
|
| $BranchLevel |
integer |
If BranchLevel greater than 1, this payment contains the
actual seller info. Optional |
|
| $ButtonSource |
string |
An identification code for use by third-party applications
to identify transactions. Optional Character length and
limitations: 32 single-byte alphanumeric characters |
|
| $Custom |
string |
A free-form field for your own use. Optional Character
length and limitations: 256 single-byte alphanumeric
characters |
|
| $EnhancedPaymentData |
PayPal\EnhancedDataTypes\EnhancedPaymentDataType |
Optional Refer to EnhancedPaymentDataType for details. |
|
| $FulfillmentAddress |
AddressType |
|
|
| $FulfillmentReferenceNumber |
string |
Thirdparty Fulfillment Reference Number. Optional Character
length and limitations: 32 alphanumeric characters. |
|
| $HandlingTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Total handling costs for this order. You must set the
currencyID attribute to one of the three-character currency
codes for any of the supported PayPal currencies. Optional
Limitations: Must not exceed $10,000 USD in any currency. No
currency symbol. Decimal separator must be a period (.), and
the thousands separator must be a comma (,). |
|
| $InsuranceOptionOffered |
string |
Information about the Insurance options. |
|
| $InsuranceTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Total shipping insurance costs for this order. Optional |
|
| $InvoiceID |
string |
Your own invoice or tracking number. Optional Character
length and limitations: 127 single-byte alphanumeric
characters |
|
| $ItemTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Sum of cost of all items in this order. You must set the
currencyID attribute to one of the three-character currency
codes for any of the supported PayPal currencies. Optional
separator must be a comma (,). |
|
| $MultiShipping |
string |
The value 1 indicates that this payment is associated with
multiple shipping addresses. Optional Character length and
limitations: Four single-byte numeric characters. |
|
| $NoteText |
string |
Note to recipient/seller. Optional Character length and
limitations: 127 single-byte alphanumeric characters. |
|
| $NotifyURL |
string |
Your URL for receiving Instant Payment Notification (IPN)
about this transaction. Optional If you do not specify
NotifyURL in the request, the notification URL from your
Merchant Profile is used, if one exists. Character length
and limitations: 2,048 single-byte alphanumeric characters |
|
| $OfferDetails |
OfferDetailsType |
Soft Descriptor supported for Sale and Auth in DEC only. For
Order this will be ignored. |
|
| $OrderDescription |
string |
Description of items the customer is purchasing. Optional
Character length and limitations: 127 single-byte
alphanumeric characters |
|
| $OrderTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Total of order, including shipping, handling, and tax. You
must set the currencyID attribute to one of the
three-character currency codes for any of the supported
PayPal currencies. Limitations: Must not exceed $10,000 USD
in any currency. No currency symbol. Decimal separator must
be a period (.), and the thousands separator must be a comma
(,). |
|
| $OrderURL |
string |
URL on Merchant site pertaining to this invoice. Optional |
|
| $PaymentAction |
string |
How you want to obtain payment. This payment action input
will be used for split payments Authorization indicates that
this payment is a basic authorization subject to settlement
with PayPal Authorization and Capture. Order indicates that
this payment is is an order authorization subject to
settlement with PayPal Authorization and Capture. Sale
indicates that this is a final sale for which you are
requesting payment. IMPORTANT: You cannot set PaymentAction
to Sale on SetExpressCheckoutRequest and then change
PaymentAction to Authorization on the final Express Checkout
API, DoExpressCheckoutPaymentRequest. Character length and
limit: Up to 13 single-byte alphabetic characters |
|
| $PaymentCategoryType |
string |
|
|
| $PaymentDetailsItem |
PaymentDetailsItemType |
Information about the individual purchased items |
|
| $PaymentReason |
string |
Indicates the purpose of this payment like Refund |
|
| $PaymentRequestID |
string |
Unique identifier and mandatory for the particular payment
request in case of multiple payment |
|
| $ProfileAddressChangeDate |
|
Date and time (in GMT in the format yyyy-MM-ddTHH:mm:ssZ) at
which address was changed by the user. |
|
| $Recurring |
string |
Flag to indicate the recurring transaction |
|
| $SellerDetails |
SellerDetailsType |
Details about the seller. Optional |
|
| $ShipToAddress |
AddressType |
Address the order will be shipped to. Optional If you
include the ShipToAddress element, the AddressType elements
are required: Name Street1 CityName CountryCode Do not set
set the CountryName element. |
|
| $ShippingDiscount |
PayPal\CoreComponentTypes\BasicAmountType |
Shipping discount for this order, specified as a negative
number. Optional |
|
| $ShippingMethod |
string |
|
|
| $ShippingTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Total shipping costs for this order. You must set the
currencyID attribute to one of the three-character currency
codes for any of the supported PayPal currencies. Optional
Limitations: Must not exceed $10,000 USD in any currency. No
currency symbol. Decimal separator must be a period (.), and
the thousands separator must be a comma (,). |
|
| $SoftDescriptor |
string |
Soft Descriptor supported for Sale and Auth in DEC only. For
Order this will be ignored. |
|
| $TaxTotal |
PayPal\CoreComponentTypes\BasicAmountType |
Sum of tax for all items in this order. You must set the
currencyID attribute to one of the three-character currency
codes for any of the supported PayPal currencies. Optional
Limitations: Must not exceed $10,000 USD in any currency. No
currency symbol. Decimal separator must be a period (.), and
the thousands separator must be a comma (,). |
|
| $TransactionId |
string |
PayPal Transaction Id, returned once DoExpressCheckout is
completed. |
|
