GetExpressCheckoutDetails API Operation (NVP)

APILegacyLast updated: October 12th 2021, @ 6:58:00 pm


Important: NVP/SOAP is a legacy integration method. We accept new integrations and support existing integrations, but there are newer solutions. If you're starting an integration, we recommend our latest solutions.

Shows information about an Express Checkout transaction.

GetExpressCheckoutDetails Request Message

GetExpressCheckoutDetails Request Fields

FieldDescription
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

FieldDescription
ACKIndicates the Success or Failure status of the transaction and whether any warnings were returned.
TOKENThe timestamped token value that was returned by SetExpressCheckout response and passed on GetExpressCheckoutDetails request.

Character length and limitations: 20 single-byte characters.

CORRELATIONIDThe ID unique to this response message. PayPal recommends you log this ID.
TIMESTAMPThe UTC date / timestamp of the response.
VERSIONThe version number of the Express Checkout (Merchant) API.
BUILDThe sub-version of the API.
CUSTOMA 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.

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

PHONENUMBuyer'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).

BILLINGAGREEMENTACCEPTEDSTATUS

Indicates whether the buyer accepted the billing agreement for a recurring payment. Currently, this field is always returned in the response for agreement based products, such as, subscriptions, reference transactions and recurring payments, as well as for regular single payment transactions.

Note: Starting in 2015, in release 120, this field will no longer be returned for single payment transactions.

Value is:

  • 0. Not accepted.
  • 1. Accepted.
REDIRECTREQUIREDFlag 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.
CHECKOUTSTATUSebl:CheckoutStatusType

Status of the checkout session. If payment is completed, the transaction identification number of the resulting transaction is returned. Value is:

  • PaymentActionNotInitiated
  • PaymentActionFailed
  • PaymentActionInProgress
  • PaymentActionCompleted

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: `partial:partials/docs/shared/cl_currencylimit_neg.en-XC`

BUYERMARKETINGEMAILBuyer's email address if the buyer provided it on the PayPal pages.

Character length and limitations: 127 single-byte characters.

CARTCHANGETOLERANCE

Indicates whether a cart's contents can be modified. If this parameter is not returned, then assume the cart can be modified.

Value is:

  • NONE — The cart cannot be changed, since financing was used and the country is Germany.
  • FLEXIBLE — The cart can be changed.

Payer Information Fields

FieldDescription
EMAILEmail address of buyer.

Character length and limitations: 127 single-byte characters.

PAYERIDUnique PayPal Customer Account identification number.

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

PAYERSTATUSStatus of buyer. Value is:
  • verified
  • unverified

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

COUNTRYCODEBuyer's country of residence in the form of ISO standard 3166 two-character country codes.

Character length and limitations: 2 single-byte characters.

BUSINESSBuyer's business name.

Character length and limitations: 127 single-byte characters.

PayerName (PersonNameType) Fields

FieldDescription
FIRSTNAMEBuyer's first name.

Character length and limitations: 64 double-byte characters.

MIDDLENAMEBuyer's middle name.

Character length and limitations: 64 double-byte characters.

LASTNAMEBuyer's last name.

Character length and limitations: 64 double-byte characters.

SUFFIXBuyer's suffix.

Character length and limitations: 12 single-byte characters.

Address Type Fields

FieldDescription
PAYMENTREQUEST_n_SHIPTONAME

Person's name associated with this shipping address. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 128 double-byte characters.

PAYMENTREQUEST_n_SHIPTOSTREET

First street address. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 300 single-byte characters.

PAYMENTREQUEST_n_SHIPTOSTREET2

Second street address. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 300 single-byte characters.

PAYMENTREQUEST_n_SHIPTOCITY

Name of city. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 40 single-byte characters.

PAYMENTREQUEST_n_SHIPTOSTATE

State or province.

`partial:partials/docs/shared/cl_shiptostate.en-XC`

You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 20 single-byte characters.

PAYMENTREQUEST_n_SHIPTOCOUNTRYCODE

Country code. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 2 single-byte characters.

PAYMENTREQUEST_n_SHIPTOCOUNTRYNAME

Country name. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: 2 single-byte characters.

PAYMENTREQUEST_n_SHIPTOPHONENUM

Phone number. You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 9, inclusive. Value is:

  • 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

PaymentInfoType Fields

Details about the payment.

FieldDescription
PAYMENTINFO_n_CURRENCYCODE

The currency code of the financing amounts; default is USD.

Character length and limitations: Three single-byte characters.

WalletItemsType Fields

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

FieldDescription

WALLETTYPEn

(Optional) Identifies the type of wallet item.

It is one of the following:

  • 2. LOYALTY_CARD.
  • 4. PRIVATE_LABEL_CREDIT_CARD.
  • 7. MERCHANT_CLOSED_LOOP_OFFER.

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.

InstrumentDetailsType Fields

Information about any promotional payment instrument used in the payment, such as, PayPal Credit® (formerly Bill Me Later®) or a private label credit card (PLCC) payment.

FieldDescription

INSTRUMENTCATEGORY

(Optional) Identifies the category of the promotional payment instrument.

It is one of the following:

  • 1. PayPal Credit® (formerly Bill Me Later®).
  • 2. A Private Label Credit Card (PLCC) or co-branded payment card.

Character length and limitations: Only a single promotional funding instrument per transaction is supported at this time.

INSTRUMENTID

(Optional) An instrument ID (issued by the external party) corresponding to the funding source used in the payment.

Character length and limitations: Only a single promotional funding instrument per transaction is supported at this time.

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.

FieldDescription

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 ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

PAYMENTREQUEST_n_CURRENCYCODE

A three-character currency code. Default: USD.

You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

PAYMENTREQUEST_n_SHIPPINGAMT

(Optional) Total shipping costs for this order. You can specify up to ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

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 ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC`

PAYMENTREQUEST_n_SHIPDISCAMT

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

Character length and limitations: `partial:partials/docs/shared/cl_currencylimit_neg.en-XC`

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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

PAYMENTREQUEST_n_TAXAMT

(Optional) Sum of tax for all items in this order. You can specify up to ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

PAYMENTREQUEST_n_DESC

(Optional) Description of items the buyer is purchasing. You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 9, inclusive.

Important: The notify URL applies only toDoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout orGetExpressCheckoutDetails.

Character length and limitations: 2,048 single-byte alphanumeric characters.

PAYMENTREQUEST_n_FULFILLMENTREFERENCENUMBER

(Optional) The reference number associated with the third-party shipping or fulfillment center.

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

PAYMENTREQUEST_n_FULFILLMENTADDRESS

(Optional) The full name of the addressee.

PAYMENTREQUEST_n_FULFILLMENTADDRESSSTREET

(Optional) The street name of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSSTREET2

(Optional) The second street name of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSCITY

(Optional) The city of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSSTATE

(Optional) The State of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSZIP

(Optional) The ZIP or postal code of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSCOUNTRYCODE

(Optional) The 2-letter country code of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSCOUNTRYNAME

(Optional) The country name of the fulfillment address.

PAYMENTREQUEST_n_FULFILLMENTADDRESSPHONENUM

(Optional) The phone number linked to the fulfillment address.

PAYMENTREQUEST_n_NOTETEXT

Note to the merchant. You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 9, inclusive.

Note: This field is only returned after a successful transaction for DoExpressCheckout has occurred.
`partial:partials/docs/shared/cl_transactionid.en-XC`
PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD

The payment method type. Specify the value InstantPaymentOnly. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

PAYMENTREQUEST_n_PAYMENTREQUESTID

A unique identifier of the specific payment request. Required when implementing parallel payments. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Character length and limitations: Up to 127 single-byte characters.

PAYMENTREQUEST_n_BUCKETCATEGORYTYPE

(Optional) The category of a payment. Value is:

  • 1. International shipping.
  • 2. Local delivery.

Payment Details Item Type Fields

FieldDescription
L_PAYMENTREQUEST_n_NAMEm

Item name. You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

Note: If the line item is a discount, a negative value must be passed in this field.
L_PAYMENTREQUEST_n_NUMBERm

Item number. You can specify up to ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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 ten payments, where n is a digit from 0 to 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). Value is:

  • Digital
  • Physical

This field is available since version 65.1.

EbayItemPaymentDetailsItemType Fields

FieldDescription
L_PAYMENTREQUEST_n_EBAYITEMNUMBERmAuction item number. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive, and m specifies the list item within the payment.

Character length: 765 single-byte characters.

L_PAYMENTREQUEST_n_EBAYITEMAUCTIONTXNIDmAuction transaction identification number. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive, and m specifies the list item within the payment.

Character length: 255 single-byte characters.

L_PAYMENTREQUEST_n_EBAYITEMORDERIDmAuction order identification number. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive, and m specifies the list item within the payment.

Character length: 64 single-byte characters.

L_PAYMENTREQUEST_n_EBAYITEMCARTIDmThe unique identifier provided by eBay for this order from the buyer. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive, and m specifies the list item within the payment.

Character length: 255 single-byte characters.

User Selected Options Type Fields

FieldDescription
SHIPPINGCALCULATIONMODEDescribes how the options that were presented to the buyer were determined. Value is:
  • API – Callback
  • API – Flatrate
INSURANCEOPTIONSELECTEDThe option that the buyer chose for insurance. Value is:
  • Yes. The buyer opted for insurance.
  • No. The buyer did not opt for insurance.
SHIPPINGOPTIONISDEFAULTIndicates whether the buyer chose the default shipping option. Value is:
  • 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

SHIPPINGOPTIONNAMEThe name of the shipping option, such as, Air or Ground.
SCHEDULEDSHIPPINGDATE

The scheduled shipping date is returned only if scheduled shipping options are passed in the request.

Character length and limitations: A string returned in a date format that corresponds to locale of the buyer; for example, the date could be in MM/DD/YYYY or MM-DD-YYYY format.

SCHEDULEDSHIPPINGPERIOD

The scheduled shipping period is returned only if scheduled shipping options are passed in the request.

Character length and limitations: The option selected by the buyer from the drop down on the Review Your Information page. It is one of the values in a string array passed by the merchant in the request; for example, it could be Morning or5:00PM-9:00PM.

Seller Details Type Fields

FieldDescription
PAYMENTREQUEST_n_SELLERPAYPALACCOUNTIDUnique 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 ten payments, where n is a digit from 0 to 9, inclusive.

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

Payment Request Info Type Fields

FieldDescription
PAYMENTREQUEST_n_TRANSACTIONIDTransaction ID for up to 10 parallel payment requests. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

`partial:partials/docs/shared/cl_transactionid.en-XC` This field is available since version 64.0.

PAYMENTREQUEST_n_PAYMENTREQUESTIDPayment request ID. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

This field is available since version 64.0.

PaymentErrorType Fields

FieldDescription
PAYMENTREQUESTINFO_n_SHORTMESSAGEPayment error short message. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.
PAYMENTREQUESTINFO_n_LONGMESSAGEPayment error long message. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.
PAYMENTREQUESTINFO_n_ERRORCODEPayment error code. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.
PAYMENTREQUESTINFO_n_SEVERITYCODEPayment error severity code. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive.

Tax Id Details Type Fields

FieldDescription
TAXIDTYPEBuyer'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.

TAXIDBuyer'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 are deprecated. Replacement fields are noted when available.

Deprecated GetExpressCheckoutDetails Response Field

FieldDescription
GIFTMESSAGE

Discontinued Sept. 8, 2016. (No replacement.)

Gift message entered by the buyer on the PayPal checkout pages.

Character length and limitations: 150 single-byte characters.

GIFTRECEIPTENABLE

Discontinued Sept. 8, 2016. (No replacement.)

Whether the buyer requested a gift receipt. Value is:

  • true - The buyer requested a gift receipt.
  • false - The buyer did not request a gift receipt.
GIFTWRAPNAME

Discontinued Sept. 8, 2016. (No replacement.)

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

Discontinued Sept. 8, 2016. (No replacement.)

Returns the gift wrap amount only if the buyer selects the gift option.

Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC`

SURVEYQUESTION

Discontinued Sept. 8, 2016. (No replacement.)

Survey question on the PayPal checkout pages.

Character length and limitations: 50 single-byte.

SURVEYCHOICESELECTED

Discontinued Sept. 8, 2016. (No replacement.)

Survey response the buyer selects on the PayPal pages.

Character length and limitations: 15 single-byte characters.

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

FieldUse this field instead
SHIPTONAMEPAYMENTREQUEST_n_SHIPTONAME
SHIPTOSTREETPAYMENTREQUEST_n_SHIPTOSTREET
SHIPTOSTREET2PAYMENTREQUEST_n_SHIPTOSTREET2
SHIPTOCITYPAYMENTREQUEST_n_SHIPTOCITY
SHIPTOSTATEPAYMENTREQUEST_n_SHIPTOSTATE
SHIPTOZIPPAYMENTREQUEST_n_SHIPTOZIP
SHIPTOCOUNTRYPAYMENTREQUEST_n_SHIPTOCOUNTRYCODE
SHIPTOPHONENUMPAYMENTREQUEST_n_SHIPTOPHONENUM
ADDRESSSTATUSPAYMENTREQUEST_n_ADDRESSSTATUS

Deprecated Payment Details Type Fields

FieldUse this field instead
AMTPAYMENTREQUEST_n_AMT
CURRENCYCODEPAYMENTREQUEST_n_CURRENCYCODE
ITEMAMTPAYMENTREQUEST_n_ITEMAMT
SHIPPINGAMTPAYMENTREQUEST_n_SHIPPINGAMT
INSURANCEAMTPAYMENTREQUEST_n_INSURANCEAMT
SHIPPINGDISCAMTPAYMENTREQUEST_n_SHIPDISCAMT
INSURANCEOPTIONOFFEREDPAYMENTREQUEST_n_INSURANCEOPTIONOFFERED
HANDLINGAMTPAYMENTREQUEST_n_HANDLINGAMT
TAXAMTPAYMENTREQUEST_n_TAXAMT
DESCPAYMENTREQUEST_n_DESC
CUSTOMPAYMENTREQUEST_n_CUSTOM
INVNUMPAYMENTREQUEST_n_INVNUM
NOTIFYURLPAYMENTREQUEST_n_NOTIFYURL
NOTETEXTPAYMENTREQUEST_n_NOTETEXT
TRANSACTIONIDPAYMENTREQUEST_n_TRANSACTIONID
ALLOWEDPAYMENTMETHODPAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD
PAYMENTREQUESTIDPAYMENTREQUEST_n_PAYMENTREQUESTID

Deprecated Payment Details Item Type Fields

FieldUse this field instead
L_NAMEnL_PAYMENTREQUEST_n_NAMEm
L_DESCnL_PAYMENTREQUEST_n_DESCm
L_AMTnL_PAYMENTREQUEST_n_AMTm
L_NUMBERnL_PAYMENTREQUEST_n_NUMBERm
L_QTYnL_PAYMENTREQUEST_n_QTYm
L_TAXAMTnL_PAYMENTREQUEST_n_TAXAMTm
L_ITEMWEIGHTTVALUEnL_PAYMENTREQUEST_n_ITEMWEIGHTVALUEm
L_ITEMWEIGHTUNITnL_PAYMENTREQUEST_n_ITEMWEIGHTUNITm
L_ITEMLENGTHVALUEnL_PAYMENTREQUEST_n_ITEMLENGTHVALUEm
L_ITEMLENGTHUNITnL_PAYMENTREQUEST_n_ITEMLENGTHUNITm
L_ITEMWIDTHVALUEnL_PAYMENTREQUEST_n_ITEMWIDTHVALUEm
L_ITEMWIDTHUNITnL_PAYMENTREQUEST_n_ITEMWIDTHUNITm
L_ITEMHEIGHTVALUEnL_PAYMENTREQUEST_n_ITEMHEIGHTVALUEm
L_ITEMHEIGHTUNITnL_PAYMENTREQUEST_n_ITEMHEIGHTUNITm

Deprecated EbayItemPaymentDetailsItemType Fields

FieldUse this field instead
L_EBAYITEMNUMBERnL_PAYMENTREQUEST_n_EBAYITEMNUMBERm
L_EBAYAUCTIONTXNIDnL_PAYMENTREQUEST_n_EBAYAUCTIONTXNIDm
L_EBAYITEMORDERIDnL_PAYMENTREQUEST_n_EBAYITEMORDERIDm
L_EBAYITEMCARTIDnL_PAYMENTREQUEST_n_EBAYITEMCARTIDm

Additional information