GetExpressCheckoutDetails API Operation (NVP)

GetExpressCheckoutDetails Request Message

GetExpressCheckoutDetails Request Fields

Field Description
METHOD

(Required) Must be GetExpressCheckoutDetails.

TOKEN

(Required) A timestamped token, the value of which was returned by SetExpressCheckout response.

Character length and limitations: 20 single-byte characters.

GetExpressCheckoutDetails Response Message

GetExpressCheckoutDetails 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.
CUSTOM A free-form field for your own use, as set by you in the Custom element of the SetExpressCheckout request.
Character length and limitations: 256 single-byte alphanumeric characters.
INVNUM Your own invoice or tracking number, as set by you in the element of the same name in the SetExpressCheckout request.
Character length and limitations: 127 single-byte alphanumeric characters.
PHONENUM Buyer's contact phone number.

Note PayPal returns a contact phone number only if your Merchant Account Profile settings require that the buyer enter one.

Character length and limitations: Field mask is XXX-XXX-XXXX (for US numbers) or +XXX XXXXXXXX (for international numbers).

PAYPALADJUSTMENT

A discount or gift certificate offered by PayPal to the buyer. This amount is represented by a negative amount. If the buyer has a negative PayPal account balance, PayPal adds the negative balance to the transaction amount, which is represented as a positive value.

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.

REDIRECTREQUIRED Flag to indicate whether you need to redirect the buyer back to PayPal after successfully completing the transaction.

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

CHECKOUTSTATUS ebl:CheckoutStatusType
Status of the checkout session. If payment is completed, the transaction identification number of the resulting transaction is returned. It is one of the following values:
  • PaymentActionNotInitiated
  • PaymentActionFailed
  • PaymentActionInProgress
  • PaymentActionCompleted
GIFTMESSAGE Gift message entered by the buyer on the PayPal checkout pages.
Character length and limitations: 150 single-byte characters.
GIFTRECEIPTENABLE Whether the buyer requested a gift receipt. It is one of the following values:
  • true - The buyer requested a gift receipt.
  • false - The buyer did not request a gift receipt.
GIFTWRAPNAME Returns the gift wrap name only if the buyer selects gift option on the PayPal pages.
Character length and limitations: 25 single-byte characters.
GIFTWRAPAMOUNT

Returns the gift wrap amount only if the buyer selects 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 Buyer's email address if the buyer provided it on the PayPal pages.
Character length and limitations: 127 single-byte characters.
SURVEYQUESTION Survey question on the PayPal checkout pages.
Character length and limitations: 50 single-byte characters.
SURVEYCHOICESELECTED Survey response the buyer selects on the PayPal pages.
Character length and limitations: 15 single-byte characters.

Payer Information Fields

Field Description
EMAIL Email address of buyer.
Character length and limitations: 127 single-byte characters.
PAYERID Unique PayPal Customer Account identification number.
Character length and limitations: 13 single-byte alphanumeric characters.
PAYERSTATUS Status of buyer. It is one of the following values:
  • verified
  • unverified

Character length and limitations: 10 single-byte alphabetic characters.

COUNTRYCODE Buyer's country of residence in the form of ISO standard 3166 two-character country codes.
Character length and limitations: 2 single-byte characters.
BUSINESS Buyer's business name.
Character length and limitations: 127 single-byte characters.

Payer Name Fields

Field Description
FIRSTNAME Buyer's first name.
Character length and limitations: 25 single-byte characters.
MIDDLENAME Buyer's middle name.
Character length and limitations: 25 single-byte characters.
LASTNAME Buyer's last name.
Character length and limitations: 25 single-byte characters.
SUFFIX Buyer's suffix.
Character length and limitations: 12 single-byte characters.

Address Type Fields

Field Description
PAYMENTREQUEST_n_SHIPTONAME Person's name associated with this shipping address. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 32 single-byte characters.
PAYMENTREQUEST_n_SHIPTOSTREET First street address. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 100 single-byte characters.
PAYMENTREQUEST_n_SHIPTOSTREET2 Second street address. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 100 single-byte characters.
PAYMENTREQUEST_n_SHIPTOCITY Name of city. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
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.
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 40 single-byte characters.
PAYMENTREQUEST_n_SHIPTOZIP U.S. ZIP code or other country-specific postal code. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 20 single-byte characters.
PAYMENTREQUEST_n_SHIPTOCOUNTRYCODE Country code. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 2 single-byte characters.
PAYMENTREQUEST_n_SHIPTOPHONENUM Phone number. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
Character length and limitations: 20 single-byte characters.
PAYMENTREQUEST_n_ADDRESSSTATUS Status of street address on file with PayPal. 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
  • Confirmed
  • Unconfirmed
PAYMENTREQUEST_n_ADDRESSNORMALIZATIONSTATUS The PayPal address normalization status for Brazilian addresses. It can have one of the following values:
  • None
  • Normalized
  • Unnormalized
  • UserPreferred

WalletItemsType Fields

Note These fields will be added in version 113 on 4/22/2014.

Details about items stored in the buyer's PayPal Wallet. This includes items such as merchant coupons and loyalty cards.

Field Description

WALLETTYPEn

(Optional) Identifies the type of wallet item.

It is one of the following:

  • LOYALTY_CARD
  • MERCHANT_COUPON

WALLETIDn

(Optional) Unique ID of the wallet item.

Character length and limitations: 64 single-byte characters maximum.

WALLETDESCRIPTIONn

(Optional) Description of the wallet item.

Character length and limitations: 512 single-byte characters maximum.

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. 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 A 3-character currency code. Default: USD.
You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.

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 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.

PAYMENREQUEST_n_INSURANCEOPTIONOFFERED (Optional) Indicates whether insurance is available as an option the buyer can choose on the PayPal pages. 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.

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_NOTIFYURL 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.
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_NOTETEXT 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_TRANSACTIONID 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 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_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

Payment Details Item Type Fields

Field Description
L_PAYMENTREQUEST_n_NAMEm Item name. 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_NAME0, L_PAYMENTREQUEST_n_NAME1).
Character length and limitations: 127 single-byte characters.
L_PAYMENTREQUEST_n_DESCm 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 only supports single payments.
Character length and limitations: 127 single-byte characters.

L_PAYMENTREQUEST_n_AMTm

Cost of 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; except for digital goods, which only supports single payments. 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.

L_PAYMENTREQUEST_n_NUMBERm 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.
L_PAYMENTREQUEST_n_QTYm Item quantity. 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_QTY0, L_PAYMENTREQUEST_n_QTY1).
Character length and limitations: Any positive integer.

L_PAYMENTREQUEST_n_TAXAMTm

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. 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 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 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 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 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_ITEMCATEGORYm Indicates whether the item is digital or physical. 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. 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 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.
Character length: 765 single-byte characters.
L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNIDm 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.
Character length: 255 single-byte characters.
L_PAYMENTREQUEST_n_EBAYITEMORDERIDm 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.
Character length: 64 single-byte characters.
L_PAYMENTREQUEST_n_EBAYITEMCARTIDm 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.
Character length: 255 single-byte characters.

User Selected Options Type 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.
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
PAYMENTREQUEST_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.

Payment Request Info Type Fields

Field Description
PAYMENTREQUEST_n_TRANSACTIONID Transaction ID for up to 10 parallel payment requests. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
This field is available since version 64.0.
PAYMENTREQUEST_n_PAYMENTREQUESTID Payment request ID. You can specify up to 10 payments, where n is a digit between 0 and 9, inclusive.
This field is available since version 64.0.

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:stringf
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.

Tax Id Details Type Fields

Field Description
TAXIDTYPE Buyer's tax ID type. This field is required for Brazil and used for Brazil only.
For Brazil use only: The tax ID type is BR_CPF for individuals and BR_CNPJ for businesses.
This field is introduced in API version 72.0.
TAXID Buyer's tax ID. This field is required for Brazil and used for Brazil only.
For Brazil use only: The tax ID is 11 single-byte characters for individuals and 14 single-byte characters for businesses.
This field is introduced in API version 72.0.

Deprecated Fields

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

Deprecated GetExpressCheckoutDetails Response Field

Field Description
NOTE (No replacement)
Text entered by the buyer on the PayPal website if you set the ALLOWNOTE field to 1 in SetExpressCheckout.
Character length and limitations: 255 single-byte characters.

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
ADDRESSSTATUS PAYMENTREQUEST_n_ADDRESSSTATUS

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
TRANSACTIONID PAYMENTREQUEST_n_TRANSACTIONID
ALLOWEDPAYMENTMETHOD PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD
PAYMENTREQUESTID PAYMENTREQUEST_n_PAYMENTREQUESTID

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

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