DoExpressCheckoutPayment API Operation (NVP)

The DoExpressCheckoutPayment API operation completes an Express Checkout transaction.If you set up a billing agreement in your SetExpressCheckout API call, the billing agreement is created when you call the DoExpressCheckoutPayment API operation.

The DoExpressCheckoutPayment API operation completes an Express Checkout transaction.
If you set up a billing agreement in your SetExpressCheckout API call, the billing agreement is created when you call the DoExpressCheckoutPayment API operation.

DoExpressCheckoutPayment Request Message

DoExpressCheckoutPayment Request Fields

Field Description
METHOD (Required) Must be DoExpressCheckoutPayment.
TOKEN (Required) The timestamped token value that was returned in the SetExpressCheckout response and passed in the GetExpressCheckoutDetails request.
Character length and limitations: 20 single-byte characters.
PAYMENTREQUEST_n_PAYMENTACTION 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. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only. 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 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.
PAYERID (Required) Unique PayPal buyer account identification number as returned in the GetExpressCheckoutDetails response
Character length and limitations: 13 single-byte alphanumeric characters.
RETURNFMFDETAILS (Optional) Flag to indicate whether you want the results returned by Fraud Management Filters. By default, you do not receive this information. It is one of the following values:
  • 0 – Do not receive FMF details (default).
  • 1 – Receive FMF details.
GIFTMESSAGE (Optional) The gift message the buyer entered on the PayPal pages.
Character length and limitations: 150 single-byte characters.
GIFTRECEIPTENABLE (Optional) Whether the buyer selected a gift receipt on the PayPal pages. It is one of the following vaues:
  • true – The buyer selected a gift message.
  • false – The buyer did not select a gift message.
GIFTWRAPNAME (Optional) Return the gift wrap name only if the buyer selected the gift option on the PayPal pages.
Character length and limitations: 25 single-byte characters.
GIFTWRAPAMOUNT

(Optional) Amount only if the buyer selected the gift option on the PayPal pages.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

BUYERMARKETINGEMAIL (Optional) The buyer email address opted in by the buyer on the PayPal pages.
Character length and limitations: 127 single-byte characters.
SURVEYQUESTION (Optional) Survey question on the PayPal pages.
Limitations: 50 single-byte characters.
SURVEYCHOICESELECTED (Optional) Survey response that the buyer selected on the PayPal pages.
Character length and limitations: 15 single-byte characters.
BUTTONSOURCE

(Optional) Identification code for use by third-party applications to identify transactions.

Character length and limitations: 32 single-byte alphanumeric characters.

SKIPBACREATION

(Optional) Merchant specified flag which indicates whether to create a billing agreement as part of DoExpressCheckout or not. This field is used for reference transactions during billing agreement creation. Merchants who offer a store account can control whether PayPal must create a billing agreement or if billing agreement creation should be skipped. Set the value of this field to true to skip the creation of a billing agreement ID.

USESESSIONPAYMENTDETAILS

(Optional) Merchant specified flag which indicates whether to use the payment details information provided in SetExpressCheckoutDetails or in DoExpressCheckoutPayment. Possible values are true, false, 1, 0. If this is set to true or 1, the payment details information would be used from what was passed in SetExpressCheckoutDetails. Any change in the paymentdetails passed in DoExpressCheckoutPayment will be ignored if this field is set to true.

Added in version 112 of the API.

Payment Details Type Fields

When implementing parallel payments, you can create up to 10 sets of payment details type parameter fields, each representing one payment you are hosting on your marketplace.

Field Description

PAYMENTREQUEST_n_AMT

The total cost of the transaction to the buyer. If shipping cost (not applicable to digital goods) and tax charges are known, include them in this value. If not, this value should be the current sub-total of the order. If the transaction includes one or more one-time purchases, this field must be equal to the sum of the purchases. Set this field to 0 if the transaction does not include a one-time purchase such as when you set up a billing agreement for a recurring payment that is not immediately charged. When the field is set to 0, purchase-specific fields are ignored. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only. For digital goods, the following must be true:

  • total cost > 0
  • total cost <= total cost passed in the call to SetExpressCheckout

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_CURRENCYCODE (Optional) A 3-character currency code. Default: USD.
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note When multiple payments are passed in one transaction, all of the payments must have the same currency code.

PAYMENTREQUEST_n_ITEMAMT

Sum of cost of all items in this order. For digital goods, this field is required. PayPal recommends that you pass the same value in the call to DoExpressCheckoutPayment that you passed in the call to SetExpressCheckout. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.

Note PAYMENTREQUEST_n_ITEMAMT is required if you specify L_PAYMENTREQUEST_n_AMTm.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_SHIPPINGAMT

(Optional) Total shipping costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note If you specify a value for PAYMENTREQUEST_n_SHIPPINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_INSURANCEAMT

(Optional) Total shipping insurance costs for this order. The value must be a non-negative currency amount or null if insurance options are offered.

You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_SHIPDISCAMT

(Optional) Shipping discount for this order, specified as a negative number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a negative number. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_INSURANCEOPTIONOFFERED

(Optional) Indicates whether insurance is available as an option the buyer can choose on the PayPal Review page. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. Is one of the following values:

  • true – The Insurance option displays the string 'Yes' and the insurance amount. If true, the total shipping insurance for this order must be a positive number.
  • false – The Insurance option displays 'No.'

PAYMENTREQUEST_n_HANDLINGAMT

(Optional) Total handling costs for this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note If you specify a value for PAYMENTREQUEST_n_HANDLINGAMT, you must also specify a value for PAYMENTREQUEST_n_ITEMAMT.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_TAXAMT

(Optional) Sum of tax for all items in this order. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.

Note PAYMENTREQUEST_n_TAXAMT is required if you specify L_PAYMENTREQUEST_n_TAXAMTm

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTREQUEST_n_DESC (Optional) Description of items the buyer is purchasing. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.

Note The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.

Character length and limitations: 127 single-byte alphanumeric characters.
PAYMENTREQUEST_n_CUSTOM (Optional) A free-form field for your own use. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.

Character length and limitations: 256 single-byte alphanumeric characters.
PAYMENTREQUEST_n_INVNUM (Optional) Your own invoice or tracking number.You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only.

Important: The value you specify is available only if the transaction includes a purchase. This field is ignored if you set up a billing agreement for a recurring payment that is not immediately charged.

Note PayPal recommends using this field to associate transactions with your internal tracking IDs or invoice numbers; populating the invoice ID field will help you pull transaction information at a later date using only your internal ID.

Character length and limitations: 256 single-byte alphanumeric characters.
PAYMENTREQUEST_n_NOTIFYURL (Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists.
(Optional) Your URL for receiving Instant Payment Notification (IPN) about this transaction. If you do not specify this value in the request, the notification URL from your Merchant Profile is used, if one exists. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Important: The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails.

Character length and limitations: 2,048 single-byte alphanumeric characters.
PAYMENTREQUEST_n_MULTISHIPPING (Optional) The value 1 indicates that this payment is associated with multiple shipping addresses. Character length and limitations: Four single-byte numeric characters.
PAYMENTREQUEST_n_NOTETEXT (Optional) Note to the merchant. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 255 single-byte characters.
PAYMENTREQUEST_n_SOFTDESCRIPTOR A per transaction description of the payment that is passed to the buyer's credit card statement. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note Ignore when PAYMENTREQUEST_n_PAYMENTACTION=Order.

PAYMENTREQUEST_n_TRANSACTIONID (Optional) Transaction identification number of the transaction that was created. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note This field is only returned after a successful transaction for DoExpressCheckout has occurred.

PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD (Optional) The payment method type. Specify the value InstantPaymentOnly. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTREQUEST_n_PAYMENTACTION 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. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive; except for digital goods, which supports single payments only. 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.
PAYMENTREQUEST_n_PAYMENTREQUESTID A unique identifier of the specific payment request. Required when implementing parallel payments. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: Up to 127 single-byte characters.
PAYMENTREQUEST_n_BUCKETCATEGORYTYPE (Optional) The category of a payment. It is one of the following values:
  • 1 - International shipping
  • 2 - Local delivery

PAYMENTREQUEST_nREDEEMEDOFFERNAME

(Optional) The name of the buyer's wallet item offer redeemed in this transaction, such as, a merchant coupon or a loyalty program card.

Character length and limits: 127 single-byte characters

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nREDEEMEDOFFERDESCRIPTION

xs:string

(Optional) Description of the offer redeemed in this transaction, such as, a merchant coupon or a loyalty program.

Character length and limits: 127 single-byte characters

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nREDEEMEDOFFERAMOUNT

(Optional) Amount of the offer redeemed in this transaction.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details..

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nREDEEMEDOFFERTYPE

(Optional) Type of the offer redeemed in this transaction.

It is one of the following:

  • LOYALTY_CARD
  • MERCHANT_COUPON

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nREDEEMEDOFFERID

xs:string

(Optional) Unique ID of the offer redeemed in this transaction or the buyer's loyalty card account number.

Character length and limits: 64 single-byte characters.

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nREDEEMEDOFFERPOINTSACCRUED

(Optional) The number of loyalty points accrued in this transaction.

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nCUMMULATIVEPOINTSNAME

(Optional) The name of the loyalty points program in which the buyer earned points in this transaction.

Character length and limits: 127 single-byte characters

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nCUMMULATIVEPOINTSDESCRIPTION

xs:string

(Optional) Description of the loyalty points program.

Character length and limits: 127 single-byte characters

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nCUMMULATIVEPOINTSTYPE

(Optional) Type of discount or loyalty program.

It is one of the following:

  • LOYALTY_CARD

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nCUMMULATIVEPOINTSID

xs:string

(Optional) Unique ID of the buyer's loyalty points account.

Character length and limits: 64 single-byte characters.

Note This field will be added in version 113 on 4/22/2014.

PAYMENTREQUEST_nCUMMULATIVEPOINTSACCRUED

(Optional) The cummulative number of loyalty points the buyer has accrued.

Note This field will be added in version 113 on 4/22/2014.

Address Fields

Field Description
PAYMENTREQUEST_n_SHIPTONAME xs:string
Person's name associated with this shipping address. It is required if using a shipping address.
Character length and limitations: 32 single-byte characters.
PAYMENTREQUEST_n_SHIPTOSTREET First street address. It is required if using a shipping address.
Character length and limitations: 100 single-byte characters.
PAYMENTREQUEST_n_SHIPTOSTREET2 (Optional) Second street address.
Character length and limitations: 100 single-byte characters.
PAYMENTREQUEST_n_SHIPTOCITY Name of city. It is required if using a shipping address.
Character length and limitations: 40 single-byte characters.
PAYMENTREQUEST_n_SHIPTOSTATE State or province.
It is required if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. PayPal accepts State codes for some countries.
Character length and limitations: 40 single-byte characters.
PAYMENTREQUEST_n_SHIPTOZIP U.S. ZIP code or other country-specific postal code. It is required if using a U.S. shipping address and may be required for other countries.
Character length and limitations: 20 single-byte characters.
PAYMENTREQUEST_n_SHIPTOCOUNTRYCODE Country code. It is required if using a shipping address.
Character length and limitations: 2 single-byte characters.
PAYMENTREQUEST_n_SHIPTOPHONENUM (Optional) Phone number.
Character length and limitations: 20 single-byte characters.

Payment Details Item Type Fields

Field Description
L_PAYMENTREQUEST_n_NAMEm Item name. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which supports single payments only. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NAME0, L_PAYMENTREQUEST_n_NAME1).
Character length and limitations: 127 single-byte characters.
This field is introduced in version 53.0.
L_PAYMENTREQUEST_n_DESCm (Optional) Item description. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which supports single payments only. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_DESC0, L_PAYMENTREQUEST_n_DESC1).
Character length and limitations: 127 single-byte characters.
This field is introduced in version 53.0.

L_PAYMENTREQUEST_n_AMTm

Cost of item. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed.You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which supports single payments only. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_AMT0, L_PAYMENTREQUEST_n_AMT1).

Note If you specify a value for L_PAYMENTREQUEST_n_AMTm, you must specify a value for PAYMENTREQUEST_n_ITEMAMT.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

This field is introduced in version 53.0.

L_PAYMENTREQUEST_n_NUMBERm (Optional) Item number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_NUMBER0, L_PAYMENTREQUEST_n_NUMBER1).
Character length and limitations: 127 single-byte characters.
This field is introduced in version 53.0.
L_PAYMENTREQUEST_n_QTYm Item quantity. This field is required when L_PAYMENTREQUEST_n_ITEMCATEGORYm is passed. For digital goods (L_PAYMENTREQUEST_n_ITEMCATEGORYm=Digital), this field is required. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which only supports single payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_QTY0, L_PAYMENTREQUEST_n_QTY1).
Character length and limitations: Any positive integer.
This field is introduced in version 53.0.

L_PAYMENTREQUEST_n_TAXAMTm

(Optional) Item sales tax. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which only supports single payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_TAXAMT0, L_PAYMENTREQUEST_n_TAXAMT1).

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

L_PAYMENTREQUEST_n_ITEMWEIGHTVALUEm, L_PAYMENTREQUEST_n_ITEMWEIGHTUNITm (Optional) Item weight corresponds to the weight of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment;. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE0, L_PAYMENTREQUEST_n_ITEMWEIGHTVALUE1).
Character length and limitations: Any positive integer.
L_PAYMENTREQUEST_n_ITEMLENGTHVALUEm, L_PAYMENTREQUEST_n_ITEMLENGTHUNITm (Optional) Item length corresponds to the length of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMLENGTHVALUE0, L_PAYMENTREQUEST_n_ITEMLENGTHVALUE1).
Character length and limitations: Any positive integer.
L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm, L_PAYMENTREQUEST_n_ITEMWIDTHUNITm (Optional) Item width corresponds to the width of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMWIDTHVALUE0, L_PAYMENTREQUEST_n_ITEMWIDTHVALUE1).
Character length and limitations: Any positive integer.
L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm, L_PAYMENTREQUEST_n_ITEMHEIGHTUNITm (Optional) Item height corresponds to the height of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE0, L_PAYMENTREQUEST_n_ITEMHEIGHTVALUE1).
Character length and limitations: Any positive integer.
L_PAYMENTREQUEST_n_ITEMURLm (Optional) URL for the item. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMURL0, L_PAYMENTREQUEST_n_ITEMURL1).
L_PAYMENTREQUEST_n_ITEMCATEGORYm Indicates whether an item is digital or physical. For digital goods, this field is required and must be set to Digital. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment; except for digital goods, which only supports single payments. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_ITEMCATEGORY0, L_PAYMENTREQUEST_n_ITEMCATEGORY1). It is one of the following values:
  • Digital
  • Physical

This field is available since version 65.1.

EbayItemPaymentDetailsItemType Fields

Field Description
L_PAYMENTREQUEST_n_EBAYITEMNUMBERm (Optional) Auction item number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMNUMBER0, L_PAYMENTREQUEST_n_EBAYITEMNUMBER1).
Character length: 765 single-byte characters.
L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNIDm (Optional) Auction transaction identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID0, L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNID1).
Character length: 255 single-byte characters.
L_PAYMENTREQUEST_n_EBAYITEMORDERIDm (Optional) Auction order identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMORDERID0, L_PAYMENTREQUEST_n_EBAYITEMORDERID1).
Character length: 64 single-byte characters.
L_PAYMENTREQUEST_n_EBAYCARTIDm (Optional) The unique identifier provided by eBay for this order from the buyer. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment. These parameters must be ordered sequentially beginning with 0 (for example L_PAYMENTREQUEST_n_EBAYITEMCARTID0, L_PAYMENTREQUEST_n_EBAYITEMCARTID1).
Character length: 255 single-byte characters.

UserSelectedOptions Fields

Field Description
INSURANCEOPTIONSELECTED (Optional) The option that the buyer chose for insurance. It is one of the following values:
  • Yes – The buyer opted for insurance.
  • No – The buyer did not opt for insurance.
SHIPPINGOPTIONISDEFAULT (Optional) Whether the buyer chose the default shipping option. It is one of the following values:
  • true – The buyer chose the default shipping option.
  • false – The buyer did not choose the default shipping option.
SHIPPINGOPTIONAMOUNT

(Optional) The shipping amount that the buyer chose.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

SHIPPINGOPTIONNAME (Optional) The name of the shipping option, such as air or ground.

Seller Details Type Fields

Field Description
PAYMENTREQUEST_n_SELLERID (Optional) Unique non-changing identifier for the merchant at the marketplace site. This ID is not displayed. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 13 single-byte alphanumeric characters.
PAYMENTREQUEST_n_SELLERUSERNAME xs:string
(Optional) Current name of the merchant or business at the marketplace site. This name may be shown to the buyer. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTREQUEST_n_SELLERREGISTRATIONDATE

(Optional) Date when the merchant registered with the marketplace. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Must be a valid date, in UTC/GMT format; for example, 2013-08-24T05:38:48Z. No wildcards are allowed.

DoExpressCheckoutPayment Response Message

DoExpressCheckoutPayment Response Fields

Field Description
TOKEN The timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.
Character length and limitations: 20 single-byte characters.
PAYMENTTYPE Information about the payment.
NOTE The text entered by the buyer on the PayPal website if you set the ALLOWNOTE field to 1 in SetExpressCheckout.
This field is available since version 53.0.
Character length and limitations: 255 single-byte characters.
REDIRECTREQUIRED Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction.
If set to true, you can redirect users to the following URL with the token value appended:
https://www.paypal.com/cgi-bin/webscr?cmd=_complete-express-checkout&token=(token)

Note Use this field only if you are using giropay or bank transfer payment methods in Germany.

SUCCESSPAGEREDIRECTREQUESTED Flag to indicate whether you would like to redirect the buyer to sign up for PayPal after completing the transaction.
If set to true, you can redirect users to the following URL with the token value appended:
https://www.paypal.com/cgi-bin/webscr?cmd=_express-checkout-success&token=(token)
BILLINGAGREEMENTID The ID of the billing agreement associated with the Express Checkout transaction.
L_PAYMENTINFO_n_FMFfilterIDm Filter ID, including the filter type, (PENDING, REPORT, or DENY), the filter ID, and the entry number, m, starting from 0. Filter ID is one of the following values:
  • 1 - AVS No Match
  • 2 - AVS Partial Match
  • 3 - AVS Unavailable/Unsupported
  • 4 - Card Security Code (CSC) Mismatch
  • 5 - Maximum Transaction Amount
  • 6 - Unconfirmed Address
  • 7 - Country Monitor
  • 8 - Large Order Number
  • 9 - Billing/Shipping Address Mismatch
  • 10 - Risky ZIP Code
  • 11 - Suspected Freight Forwarder Check
  • 12 - Total Purchase Price Minimum
  • 13 - IP Address Velocity
  • 14 - Risky Email Address Domain Check
  • 15 - Risky Bank Identification Number (BIN) Check
  • 16 - Risky IP Address Range
  • 17 - PayPal Fraud Model

You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment.

L_PAYMENTINFO_n_FMFfilterNAMEm Filter name, including the filter type, (PENDING, REPORT, or DENY), the filter NAME, and the entry number, m, starting from 0. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment.

Payment Information Fields

When implementing parallel payments, up to 10 payment information type sets of payment information type parameter fields can be returned, each representing one payment you are hosting on your marketplace.

Field Description
PAYMENTINFO_n_TRANSACTIONID Unique transaction ID of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Note If the PaymentAction of the request was Authorization or Order, this value is your AuthorizationID for use with the Authorization & Capture APIs.

Character length and limitations: 19 single-byte characters.
PAYMENTINFO_n_TRANSACTIONTYPE Type of transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • cart
  • express-checkout
Character length and limitations: 15 single-byte characters.
PAYMENTINFO_n_PAYMENTTYPE Indicates whether the payment is instant or delayed. It is one of the following values:
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • none
  • echeck
  • instant
Character length and limitations: 7 single-byte characters.
PAYMENTINFO_n_ORDERTIME

Date/time stamp of the payment.

Character length and limitations: Date and time are in UTC/GMT format; for example, 2013-08-24T05:38:48Z.

PAYMENTINFO_n_AMT

The final amount charged, including any shipping and taxes from your Merchant Profile. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTINFO_n_CURRENCYCODE A 3-character currency code. Default: USD.

PAYMENTINFO_n_FEEAMT

PayPal fee amount charged for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTINFO_n_SETTLEAMT

Amount deposited in your PayPal account after a currency conversion. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTINFO_n_TAXAMT

Tax charged on the transaction.

You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

PAYMENTINFO_n_EXCHANGERATE Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point.
PAYMENTINFO_n_PAYMENTSTATUS The status of the payment. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • None – No status.
  • Canceled-Reversal – A reversal has been canceled; for example, when you win a dispute and the funds for the reversal have been returned to you.
  • Completed – The payment has been completed, and the funds have been added successfully to your account balance.
  • Denied – You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.
  • Expired – the authorization period for this payment has been reached.
  • Failed – The payment has failed. This happens only if the payment was made from your buyer's bank account.
  • In-Progress – The transaction has not terminated, e.g. an authorization may be awaiting completion.
  • Partially-Refunded – The payment has been partially refunded.
  • Pending – The payment is pending. See the PendingReason field for more information.
  • Refunded – You refunded the payment.
  • Reversed – A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.
  • Processed – A payment has been accepted.
  • Voided – An authorization for this transaction has been voided.
  • Completed-Funds-Held – The payment has been completed, and the funds have been added successfully to your pending balance.
    See the PAYMENTINFO_n_HOLDDECISION field for more information.
PAYMENTINFO_n_PENDINGREASON Reason the payment is pending. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • none – No pending reason.
  • address – The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
  • authorization – The payment is pending because it has been authorized but not settled. You must capture the funds first.
  • echeck – The payment is pending because it was made by an eCheck that has not yet cleared.
  • intl – The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.
  • multi-currency – You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.
  • order – The payment is pending because it is part of an order that has been authorized but not settled.
  • paymentreview – The payment is pending while it is being reviewed by PayPal for risk.
  • regulatoryreview - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review.
  • unilateral – The payment is pending because it was made to an email address that is not yet registered or confirmed.
  • verify – The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
  • other – The payment is pending for a reason other than those listed above. For more information, contact PayPal customer service.

Note PendingReason is returned in the response only if PaymentStatus is Pending.

PAYMENTINFO_n_REASONCODE Reason for a reversal if TransactionType is reversal. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • none – No reason code.
  • chargeback – A reversal has occurred on this transaction due to a chargeback by your buyer.
  • guarantee – A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.
  • buyer-complaint – A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.
  • refund – A reversal has occurred on this transaction because you have given the buyer a refund.
  • other – A reversal has occurred on this transaction due to a reason not listed above.
PAYMENTINFO_n_HOLDDECISION Reason that this payment is being held. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • newsellerpaymenthold – This is a new merchant.
  • paymenthold – A hold is placed on the merchant's transaction for a reason not listed.

This field is available since version 71.0 and is returned only if PAYMENTINFO_n_PAYMENTSTATUS is Completed-Funds-Held.

PAYMENTINFO_n_PROTECTIONELIGIBILITY Prior to version 64.4, the kind of seller protection in force for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • Eligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
  • PartiallyEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
  • Ineligible – Merchant is not protected under the Seller Protection Policy.
PAYMENTINFO_n_PROTECTIONELIGIBILITYTYPE Since version 64.4, the kind of seller protection in force for the transaction. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive. It is one of the following values:
  • Eligible – Merchant is protected by PayPal's Seller Protection Policy for both Unauthorized Payment and Item Not Received
  • ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received
  • UnauthorizedPaymentEligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment
  • Ineligible – Merchant is not protected under the Seller Protection Policy

This field is available since version 64.4.

STOREID xs:string
StoreId as entered in the transaction.
TERMINALID xs:string
TerminalId as entered in the transaction.
PAYMENTINFO_n_EBAYITEMAUCTIONTXNID eBay transaction identification number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 255 single-byte characters.
PAYMENTINFO_n_PAYMENTREQUESTID Unique identifier of the specific payment request. The value should match the one you passed in the DoExpressCheckout request. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: Up to 127 single-byte characters.
L_PAYMENTINFO_n_FMFfilterIDm Filter ID, including the filter type, (PENDING, REPORT, or DENY), the filter ID, and the entry number, m, starting from 0. Filter ID is one of the following values:
  • 1 - AVS No Match
  • 2 - AVS Partial Match
  • 3 - AVS Unavailable/Unsupported
  • 4 - Card Security Code (CSC) Mismatch
  • 5 - Maximum Transaction Amount
  • 6 - Unconfirmed Address
  • 7 - Country Monitor
  • 8 - Large Order Number
  • 9 - Billing/Shipping Address Mismatch
  • 10 - Risky ZIP Code
  • 11 - Suspected Freight Forwarder Check
  • 12 - Total Purchase Price Minimum
  • 13 - IP Address Velocity
  • 14 - Risky Email Address Domain Check
  • 15 - Risky Bank Identification Number (BIN) Check
  • 16 - Risky IP Address Range
  • 17 - PayPal Fraud Model

You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment.

L_PAYMENTINFO_n_FMFfilterNAMEm Filter name, including the filter type, (PENDING, REPORT, or DENY), the filter NAME, and the entry number, m, starting from 0. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive, and m specifies the list item within the payment.
PAYMENTINFO_n_SHIPPINGAMT Amount of shipping charged on this transaction.
Character length and limitations: Must not exceed $10,000 USD in any currency. No currency symbol. Regardless of currency, decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Equivalent to nine characters maximum for USD.
If you specify a value for PAYMENTINFO_n_SHIPPINGAMT, you must also specify a value for PAYMENTINFO_n_ITEMAMT.
PAYMENTINFO_n_SELLERID Unique, non-changing identifier for the merchant at the marketplace site. (Optional)
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 13 single-byte alphanumeric characters.
PAYMENTINFO_n_SELLERUSERNAME Current name of the merchant or business at the marketplace site. This name may be shown to the buyer.
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTINFO_n_SELLERREGISTRATIONDATE

Date when the merchant registered with the marketplace.

Up to 10 payments can be specified, where n is a digit between 0 and 9, inclusive.

Character length and limitations: Date and time are in UTC/GMT format; for example, 2013-08-24T05:38:48Z.

PAYMENTINFO_n_PARENTTRANSACTIONID Parent or related transaction identification number. This field is populated for the following transaction types:
  • Reversal
  • Capture of an authorized transaction
  • Reauthorization of a transaction
  • Capture of an order. The value of ParentTransactionID is the original OrderID.
  • Authorization of an order. The value of ParentTransactionID is the original OrderID.
  • Capture of an order authorization
  • Void of an order. The value of ParentTransactionID is the original OrderID.

Character length and limits: 19 single-byte characters maximum.

PAYMENTINFO_n_RECEIPTID Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format.
PAYMENTINFO_n_EXPECTEDECHECKCLEARDATE eCheck latest expected clear date.
PAYMENTINFO_n_SHIPPINGMETHOD Shipping method selected by the user during check-out.
PAYMENTINFO_n_INSTRUMENTCATEGORY Returns the category of the instrument only when it is promotional. Possible values are:
1 represents Bill Me Later
PAYMENTINFO_n_INSTRUMENTID Reserved for future use.
Returns the instrument ID (issued by the external party) corresponding to the funding source used in the payment.
PAYMENTINFO_n_OFFERCODE Code used to identify the promotion offer.
PAYMENTINFO_n_OFFERTRACKINGID Unique identification for merchant/buyer/offer combo.

Payment Error Type Fields

Field Description
PAYMENTINFO_n_SHORTMESSAGE xs:string
Payment error short message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTINFO_n_LONGMESSAGE xs:string
Payment error long message. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTINFO_n_ERRORCODE xs:string
Payment error code. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTINFO_n_SEVERITYCODE xs:string
Payment error severity code. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
PAYMENTINFO_n_ACK xs:string
Application-specific error values indicating more about the error condition. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

UserSelectedOptions Fields

Field Description
SHIPPINGCALCULATIONMODE Describes how the options that were presented to the buyer were determined. It is one of the following values:
  • API - Callback
  • API - Flatrate
INSURANCEOPTIONSELECTED The option that the buyer chose for insurance. It is one of the following values:
  • Yes – The buyer opted for insurance.
  • No – The buyer did not opt for insurance.
SHIPPINGOPTIONISDEFAULT Indicates whether the buyer chose the default shipping option. It is one of the following values:
  • true – The buyer chose the default shipping option.
  • false – The buyer did not choose the default shipping option.

Character length and limitations: true or false

SHIPPINGOPTIONAMOUNT

The shipping amount that the buyer chose.

Character length and limitations: Value is a positive number which cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require 2 decimal places, the decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

SHIPPINGOPTIONNAME The name of the shipping option, such as air or ground.

Seller Details Type Fields

Field Description
PAYMENTINFO_n_SELLERPAYPALACCOUNTID Unique identifier for the merchant. For parallel payments, this field contains either the Payer Id or the email address of the merchant. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 127 single-byte alphanumeric characters.
PAYMENTINFO_n_SECUREMERCHANTACCOUNTID Unique PayPal customer account number (of the merchant). This field is returned in the response. It is ignored if passed in the request.

Deprecated Fields

The following fields have been deprecated since version 63.0. Use the newer fields in the following tables instead.

Deprecated DoExpressCheckoutPayment Request Field

Field Use this field instead
PAYMENTACTION PAYMENTREQUEST_n_PAYMENTACTION

Deprecated Payment Details Type Fields

Field Use this field instead
AMT PAYMENTREQUEST_n_AMT
CURRENCYCODE PAYMENTREQUEST_n_CURRENCYCODE
ITEMAMT PAYMENTREQUEST_n_ITEMAMT
SHIPPINGAMT PAYMENTREQUEST_n_SHIPPINGAMT
INSURANCEAMT PAYMENTREQUEST_n_INSURANCEAMT
SHIPPINGDISCAMT PAYMENTREQUEST_n_SHIPDISCAMT
INSURANCEOPTIONOFFERED PAYMENTREQUEST_n_INSURANCEOPTIONOFFERED
HANDLINGAMT PAYMENTREQUEST_n_HANDLINGAMT
TAXAMT PAYMENTREQUEST_n_TAXAMT
DESC PAYMENTREQUEST_n_DESC
CUSTOM PAYMENTREQUEST_n_CUSTOM
INVNUM PAYMENTREQUEST_n_INVNUM
NOTIFYURL PAYMENTREQUEST_n_NOTIFYURL
NOTETEXT PAYMENTREQUEST_n_NOTETEXT
SOFTDESCRIPTOR PAYMENTREQUEST_n_SOFTDESCRIPTOR
TRANSACTIONID PAYMENTREQUEST_n_TRANSACTIONID
ALLOWEDPAYMENTMETHOD PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD
PAYMENTACTION PAYMENTREQUEST_n_PAYMENTACTION
PAYMENTREQUESTID PAYMENTREQUEST_n_PAYMENTREQUESTID

Deprecated Address Type Fields

Field Use this field instead
SHIPTONAME PAYMENTREQUEST_n_SHIPTONAME
SHIPTOSTREET PAYMENTREQUEST_n_SHIPTOSTREET
SHIPTOSTREET2 PAYMENTREQUEST_n_SHIPTOSTREET2
SHIPTOCITY PAYMENTREQUEST_n_SHIPTOCITY
SHIPTOSTATE PAYMENTREQUEST_n_SHIPTOSTATE
SHIPTOZIP PAYMENTREQUEST_n_SHIPTOZIP
SHIPTOCOUNTRY PAYMENTREQUEST_n_SHIPTOCOUNTRYCODE
SHIPTOPHONENUM PAYMENTREQUEST_n_SHIPTOPHONENUM

Deprecated Payment Details Item Type Fields

Field Use this field instead
L_NAMEn L_PAYMENTREQUEST_n_NAMEm
L_DESCn L_PAYMENTREQUEST_n_DESCm
L_AMTn L_PAYMENTREQUEST_n_AMTm
L_NUMBERn L_PAYMENTREQUEST_n_NUMBERm
L_QTYn L_PAYMENTREQUEST_n_QTYm
L_TAXAMTn L_PAYMENTREQUEST_n_TAXAMTm
L_ITEMWEIGHTTVALUEn L_PAYMENTREQUEST_n_ITEMWEIGHTVALUEm
L_ITEMWEIGHTUNITn L_PAYMENTREQUEST_n_ITEMWEIGHTUNITm
L_ITEMLENGTHVALUEn L_PAYMENTREQUEST_n_ITEMLENGTHVALUEm
L_ITEMLENGTHUNITn L_PAYMENTREQUEST_n_ITEMLENGTHUNITm
L_ITEMWIDTHVALUEn L_PAYMENTREQUEST_n_ITEMWIDTHVALUEm
L_ITEMWIDTHUNITn L_PAYMENTREQUEST_n_ITEMWIDTHUNITm
L_ITEMHEIGHTVALUEn L_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm
L_ITEMHEIGHTUNITn L_PAYMENTREQUEST_n_ITEMHEIGHTUNITm
L_ITEMURLn L_PAYMENTREQUEST_n_ITEMURLm

Deprecated EbayItemPaymentDetailsItemType Fields

Field Use this field instead
L_EBAYITEMNUMBERn L_PAYMENTREQUEST_n_EBAYITEMNUMBERm
L_EBAYAUCTIONTXNIDn L_PAYMENTREQUEST_n_EBAYAUCTIONTXNIDm
L_EBAYITEMORDERIDn L_PAYMENTREQUEST_n_EBAYITEMORDERIDm
L_EBAYITEMCARTIDn L_PAYMENTREQUEST_n_EBAYITEMCARTIDm

Deprecated Seller Details Type Fields

Field Use this field instead
SELLERID PAYMENTREQUEST_n_SELLERID
SELLERUSERNAME PAYMENTREQUEST_n_SELLERUSERNAME
SELLERREGISTRATIONDATE PAYMENTREQUEST_n_SELLERREGISTRATIONDATE

DoExpressCheckoutPayment Response Fields

Field Use this field instead
L_FMFfilterIDn L_PAYMENTINFO_n_FMFfilterIDm
L_FMFfilterNAMEn L_PAYMENTINFO_n_FMFfilterNAMEm

Payment Information Fields

Field Use this field instead
TRANSACTIONID PAYMENTINFO_n_TRANSACTIONID
TRANSACTIONTYPE PAYMENTINFO_n_TRANSACTIONTYPE
PAYMENTTYPE PAYMENTINFO_n_PAYMENTTYPE
ORDERTIME PAYMENTINFO_n_ORDERTIME
AMT PAYMENTINFO_n_AMT
CURRENCYCODE PAYMENTINFO_n_CURRENCYCODE
FEEAMT PAYMENTINFO_n_FEEAMT
SETTLEAMT PAYMENTINFO_n_SETTLEAMT
TAXAMT PAYMENTINFO_n_TAXAMT
EXCHANGERATE PAYMENTINFO_n_EXCHANGERATE
PAYMENTSTATUS PAYMENTINFO_n_PAYMENTSTATUS
PENDINGREASON PAYMENTINFO_n_PENDINGREASON
REASONCODE PAYMENTINFO_n_REASONCODE
PROTECTIONELIGIBILITY PAYMENTINFO_n_PROTECTIONELIGIBILITY
EBAYITEMAUCTIONTXNID PAYMENTINFO_n_EBAYITEMAUCTIONTXNID
PAYMENTREQUESTID PAYMENTINFO_n_PAYMENTREQUESTID
L_FMFfilterIDn L_PAYMENTINFO_n_FMFfilterIDm
L_FMFfilterNAMEn L_PAYMENTINFO_n_FMFfilterNAMEm
SHIPPINGAMT PAYMENTINFO_n_SHIPPINGAMT
PARENTTRANSACTIONID PAYMENTINFO_n_PARENTTRANSACTIONID
RECEIPTID PAYMENTINFO_n_RECEIPTID
EXPECTEDECHECKCLEARDATE PAYMENTINFO_n_EXPECTEDECHECKCLEARDATE
SHIPPINGMETHOD PAYMENTINFO_n_SHIPPINGMETHOD