On this page
No Headings
GetExpressCheckoutDetails API Operation (SOAP)
Last updated: June 18, 2026
API
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
Note: Only the fields described in this documentation are available for use.
GetExpressCheckoutDetails Request Fields
| Field | Description |
|---|---|
Token | xs:string(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 | xs:stringThe timestamped token value that was returned by SetExpressCheckout response and passed in the GetExpressCheckoutDetails request.Character length and limitations: 20 single-byte characters |
Custom | xs:stringA 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 |
PayerInfo | ebl:PayerInfoTypeInformation about the payer. |
InvoiceID | xs:stringYour 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 |
ContactPhone | xs:stringBuyer's contact phone number. Note: PayPal returns a contact phone number only if your Merchant Account Profile settings require that the buyer enter one. |
BillingAgreementAcceptedStatus | xs:booleanIndicates 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. |
RedirectRequired | xs:booleanFlag 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. |
BillingAddress | ebl:AddressTypeThe buyer's billing address. If a credit card is stored in the buyer's account, then the card billing address is returned; otherwise, the buyer's primary address is returned. |
CheckoutStatus | ebl:CheckoutStatusTypeStatus of the checkout session. If payment is completed, the transaction identification number of the resulting transaction is returned. Value is:
|
PayPalAdjustment | cc:BasicAmountTypeA 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. |
PaymentDetails | ebl:PaymentDetailsTypeInformation about the purchased items. |
UserSelectedOptions | ebl:UserSelectedOptionsTypeShipping options and insurance. |
IncentiveDetails | ebl:IncentiveDetailsTypeInformation about the incentives that were applied from the Ebay Review Your Payment page or PayPal Review Your Payment page. |
BuyerMarketingEmail | ebl:EmailAddressTypeBuyer's email address if the buyer provided it on the PayPal pages. Character length and limitations: 127 single-byte characters |
PaymentRequestInfo | ebl:PaymentRequestInfoTypePayment request information for each bucket in the cart. |
PaymentInfo | ebl:PaymentInfoTypeInformation about the transaction. |
CartChangeTolerance | xs:stringIndicates whether a cart's contents can be modified. If this parameter is not returned, then assume the cart can be modified. Value is:
|
InstrumentDetails | ebl:InstrumentDetailsTypeType of the payment instrument. |
PayerInfoType Fields
| Field | Description |
|---|---|
Payer | ebl:EmailAddressTypeEmail address of buyer. Character length and limitations: 127 single-byte characters |
PayerID | ebl:UserIDTypeUnique PayPal Customer Account identification number. Character length and limitations: 13 single-byte alphanumeric characters |
PayerStatus | ebl:PayPalUserStatusCodeTypeStatus of buyer. Value is:
|
PayerName | ebl:PersonNameTypeFirst and last name of buyer. |
PayerCountry | ebl:CountryCodeTypeBuyer's country of residence in the form of ISO standard 3166 two-character country codes. Character length and limitations: 2 single-byte characters |
PayerBusiness | xs:stringBuyer's business name. Character length and limitations: 127 single-byte characters |
Address | ebl:AddressTypeBuyer's shipping address information. |
ContactPhone | xs:stringBusiness contact telephone number. |
WalletItems | ebl:WalletItemsTypeDetails about items stored in the buyer's PayPal Wallet. This includes items, such as, merchant coupons and loyalty cards. |
InstrumentDetails | ebl:InstrumentDetailsTypeDetails about any promotional payment instruments used in the payment. |
TaxIdDetails | ebl:TaxIdDetailsTypeDetails about the buyer's tax information. This field is introduced in API version 72.0. |
PersonNameType Fields
| Field | Description |
|---|---|
FirstName | ebl:PersonNameTypeBuyer's first name. Character length and limitations: 64 double-byte characters |
MiddleName | ebl:NameUserBuyer's middle name. Character length and limitations: 64 double-byte characters |
LastName | ebl:NameTypeBuyer's last name. Character length and limitations: 64 double-byte characters |
Suffix | ebl:SuffixTypeBuyer's suffix. Character length and limitations: 12 single-byte characters |
AddressType Fields
| Field | Description |
|---|---|
Name | xs:stringPerson's name associated with this shipping address. Character length and limitations: 128 double-byte characters |
Street1 | xs:stringFirst street address. Character length and limitations: 300 single-byte characters |
Street2 | xs:stringSecond street address. Character length and limitations: 300 single-byte characters |
CityName | xs:stringName of city. Character length and limitations: 40 single-byte characters |
StateOrProvince | xs:stringRequired for transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA. See the list of PayPal state codes.Character length and limitations: 40 single-byte characters |
PostalCode | xs:stringU.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
Country | ebl:CountryCodeTypeCountry code. Character length and limitations: 2 single-byte characters |
Phone | xs:stringPhone number. Character length and limitations: 20 single-byte characters |
addressStatus | ebl:addressStatusTypeCodeStatus of street address on file with PayPal. Value is:
|
AddressNormalizationStatus | ebl:AddressNormalizationStatusCodeTypeThe PayPal address normalization status for Brazilian addresses. It can have one of the following values:
|
PaymentInfoType Fields
Details about the payment.
| Field | Description |
|---|---|
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.
| Field | Description |
|---|---|
Type | ebl:WalletItemType(Optional) Identifies the type of wallet item. It is one of the following:
|
Id | xs:string(Optional) Unique ID of the wallet item. Character length and limitations: 64 single-byte characters maximum. |
Description | xs:string(Optional) Description of the wallet item. Character length and limitations: 512 single-byte characters maximum. |
InstrumentDetailsType Fields
Details about any promotional payment instruments in the payment.
| Field | Description |
|---|---|
InstrumentCategory | xs:string(Optional) The category of the promotional payment instrument. It is one of the following:
|
InstrumentID | xs:string(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. |
PaymentDetailsType 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 |
|---|---|
OrderTotal | ebl:BasicAmountTypeThe 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. For digital goods, the following must be true:
Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
ItemTotal | ebl:BasicAmountTypeSum 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. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
ShippingTotal | ebl:BasicAmountType(Optional) Total shipping costs for this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
InsuranceTotal | ebl:BasicAmountType(Optional) Total shipping insurance costs for this order. The value must be a non-negative currency amount or null if you offer insurance options. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.InsuranceTotal is available since version 53.0. |
ShippingDiscount | ebl:BasicAmountType(Optional) Shipping discount for this order, specified as a negative number. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.ShippingDiscount is available since version 53.0. |
InsuranceOptionOffered | xs:boolean(Optional) Indicates whether insurance is available as an option the buyer can choose on the PayPal pages. Is one of the following values:
|
HandlingTotal | ebl:BasicAmountType(Optional) Total handling costs for this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
TaxTotal | ebl:BasicAmountType(Optional) Sum of tax for all items in this order. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
OrderDescription | xs:string(Optional) Description of items the buyer is purchasing. 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. |
Custom | xs:string(Optional) A free-form field for your own use. 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. |
InvoiceID | xs:string(Optional) Your own invoice or tracking number. 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. |
NotifyURL | xs:stringYour 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. Important: The notify URL applies only to DoExpressCheckoutPayment. This value is ignored when set in SetExpressCheckout or GetExpressCheckoutDetails. |
FulfillmentReferenceNumber | xs:string(Optional) The reference number associated with the third-party shipping or fulfillment center. Character length and limitations: 32 single-byte alphanumeric characters |
FulfillmentAddress | ebl:AddressType(Optional) The address of the third-party shipping or fulfillment center |
PaymentCategoryType | ebl:PaymentCategoryType(Optional) Category of a payment. Value is: InternationalShippingLocalDelivery |
ShipToAddress | ebl:AddressTypeAddress the order is shipped to. |
PaymentDetailsItem | ebl:PaymentDetailsItemTypeDetails about each individual item included in the order. |
NoteText | xs:stringNote to the merchant. Character length and limitations: 255 single-byte characters |
TransactionId | xs:stringTransaction identification number of the transaction that was created. Note: This field is only returned after a successful transaction for DoExpressCheckout has occurred. |
AllowedPaymentMethodType | xs:stringThe payment method type. If this is an Immediate Payment, specify the value InstantPaymentOnly. |
PaymentRequestID | xs:stringA unique identifier of the specific payment request. Required when implementing parallel payments. Character length and limitations: Up to 127 single-byte characters |
PaymentDetailsItemType Fields
| Field | Description |
|---|---|
Name | xs:stringItem name. Character length and limitations: 127 single-byte characters |
Description | xs:stringItem description. Character length and limitations: 127 single-byte characters This field is available since version 53.0. |
Amount | ebl:BasicAmountTypeCost of item. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. Note: If the line item is a discount, a negative value must be passed in this field. |
Number | xs:stringItem number. Character length and limitations: 127 single-byte characters |
Quantity | xs:integerItem quantity. Character length and limitations: Any positive integer |
Tax | ebl:BasicAmountTypeItem sales tax. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
ItemWeight | xs:integerWeight of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. Character length and limitations: Any positive integer |
ItemLength | xs:integerLength of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. Character length and limitations: Any positive integer |
ItemWidth | xs:integerWidth of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. Character length and limitations: Any positive integer |
ItemHeight | xs:integerHeight of the item. You can pass this data to the shipping carrier as is without having to make an additional database query. Character length and limitations: Any positive integer |
EbayItemPayment DetailsItem | eBl:ebayItemPaymentDetailsItemTypeInformation relating to an auction sale on eBay. |
ItemCategory | ns:ItemCategoryTypeIndicates whether the item is digital or physical. For digital goods ( ItemCategory=Digital), this field is required. Value is:
|
EbayItemPaymentDetailsItemType Fields
| Field | Description |
|---|---|
ItemNumber | xs:stringAuction item number. Character length: 765 single-byte characters |
AuctionTransactionId | xs:stringAuction transaction identification number. Character length: 255 single-byte characters |
OrderID | xs:stringAuction order identification number. Character length: 64 single-byte characters |
CartID | xs:stringThe unique identifier provided by eBay for this order from the buyer. Character length: 255 single-byte characters |
UserSelectedOptionsType Fields
| Field | Description |
|---|---|
ShippingCalculationMode | xs:stringDescribes how the options that were presented to the buyer were determined. Value is:
|
InsuranceOptionSelected | xs:booleanThe option that the buyer chose for insurance. Value is:
|
ShippingOptionIsDefault | xs:booleanIndicates whether the buyer chose the default shipping option. Value is:
|
ShippingOptionAmount | ebl:BasicAmountTypeThe shipping amount that the buyer chose. Character length and limitations: Value is typically a positive number that cannot exceed nine (9) digits in SOAP request/response for USD, CLP, or JPY or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period ( .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
ShippingOptionName | xs:stringThe name of the shipping option, such as Air or Ground. |
ScheduledShippingDate | xs:stringThe 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 | xs:stringThe 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 or 5:00PM-9:00PM. |
IncentiveDetailsType Fields
Information about the incentives that were applied from the eBay Review Your Payment page and PayPal Review Your Payment page.
| Field | Description |
|---|---|
UniqueIdentifier | xs:stringA unique identifier consisting of a redemption code, a user friendly description, incentive type, campaign code, incentive application order and the site on which it was redeemed. |
SiteAppliedOn | ebl:IncentiveSiteAppliedOnTypeDefines if the incentive has been applied on eBay or PayPal. It is one of the following:
|
TotalDiscountAmount | cc:BasicAmountTypeThe total discount amount for the incentive; a summation of discounts up across all the buckets/items. |
Status | ebl:IncentiveAppliedStatusTypeStatus of incentive processing. Sussess or Error. It is one of the following:
|
ErrorCode | xs:integerThe error code if there are any errors; otherwise, zero is returned. |
IncentiveAppliedDetails | ebl:IncentiveAppliedDetailsTypeDetails of the incentive applied to an individual bucket / item. |
IncentiveAppliedDetailsType Fields
Details of the incentive applied to an individual bucket / item.
| Field | Description |
|---|---|
PaymentRequestID | xs:stringUniquely identifies a bucket or a bucket ID in Express Checkout. |
ItemId | xs:stringThe item ID passed by the merchant. |
ExternalTxnId | xs:stringThe item transaction ID passed through by the merchant. |
DiscountAmount | cc:BasicAmountTypeThe discount offerred for this bucket or item. |
SubType | xs:stringThe sub-category type for the coupon. |
SellerDetailsType Fields
| Field | Description |
|---|---|
PayPalAccountID | xs:stringUnique identifier for the merchant. For parallel payments, this field contains either the Payer ID or the email address of the merchant. Character length and limitations: 127 single-byte alphanumeric characters |
PaymentRequestInfoType Fields
| Field | Description |
|---|---|
TransactionId | xs:stringTransaction ID for up to 10 parallel payment requests. Character length and limitations: 17 characters. Orders transactions have 19 characters.This field is available since version 64.0. |
PaymentRequestID | xs:stringPayment request ID for up to 10 payment requests. This field is available since version 64.0. |
PaymentError | ebl:ErrorTypeErrors associated with the bucket of parallel payment requests. This field is available since version 64.0. |
ErrorType Fields
| Field | Description |
|---|---|
ShortMessage | xs:stringPayment error short message. |
LongMessage | xs:stringPayment error long message. |
ErrorCode | xs:stringPayment error code. |
SeverityCode | xs:stringPayment error severity code. |
ErrorParameters | xs:stringApplication-specific error values indicating more about the error condition. |
TaxIdDetailsType Fields
| Field | Description |
|---|---|
TaxIdType | xs:stringBuyer'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 | xs:stringBuyer'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.
Deprecated GetExpressCheckoutDetails Response Fields
| Field | Description |
|---|---|
GiftMessage | Discontinued Sept. 8, 2016. (No replacement.)xs:stringGift 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.)xs:stringWhether the buyer requested a gift receipt. Value is:
|
GiftWrapName | Discontinued Sept. 8, 2016. (No replacement.)xs:stringReturns 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.)ebl:BasicAmountTypeReturns the gift wrap amount only if the buyer selects the gift option on the PayPal pages. Note: You must set the currencyID attribute to one of the 3-character currency codes for any of the supported PayPal currencies. .), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page. |
SurveyQuestion | Discontinued Sept. 8, 2016. (No replacement.)xs:stringSurvey question on the PayPal checkout pages. Character length and limitations: 50 single-byte characters |
SurveyChoiceSelected | Discontinued Sept. 8, 2016. (No replacement.)xs:stringSurvey response the buyer selects on the PayPal pages. Character length and limitations: 15 single-byte characters |
Note | (No replacement.)xs:stringText 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. |