GetExpressCheckoutDetails API Operation (NVP)
APILegacyLast updated: October 12th 2021, @ 6:58:00 pm
Shows information about an Express Checkout transaction.
GetExpressCheckoutDetails Request Message
GetExpressCheckoutDetails Request Fields
Field | Description |
---|---|
METHOD | (Required) Must be |
TOKEN | (Required) A timestamped token, the value of which was returned by |
GetExpressCheckoutDetails Response Message
GetExpressCheckoutDetails Response Fields
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. Value is:
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. |
PayerName (PersonNameType) Fields
Field | Description |
---|---|
FIRSTNAME | Buyer's first name. Character length and limitations: 64 double-byte characters. |
MIDDLENAME | Buyer's middle name. Character length and limitations: 64 double-byte characters. |
LASTNAME | Buyer's last name. Character length and limitations: 64 double-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 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:
|
PAYMENTREQUEST_n_ADDRESSNORMALIZATIONSTATUS | The 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 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 |
---|---|
| (Optional) Identifies the type of wallet item. It is one of the following:
|
| (Optional) Unique ID of the wallet item. Character length and limitations: 64 single-byte characters maximum. |
| (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.
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 |
---|---|
| 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:
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. |
| 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 Note: Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| (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 Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| (Optional) Total shipping insurance costs for this order. The value must be a non-negative currency amount or |
| (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:
|
| (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 Character length and limitations: `partial:partials/docs/shared/cl_currencylimit.en-XC` |
| (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: 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 to Character length and limitations: 2,048 single-byte alphanumeric characters. |
| (Optional) The reference number associated with the third-party shipping or fulfillment center. Character length and limitations: 32 single-byte alphanumeric characters. |
| (Optional) The full name of the addressee. |
| (Optional) The street name of the fulfillment address. |
| (Optional) The second street name of the fulfillment address. |
| (Optional) The city of the fulfillment address. |
| (Optional) The State of the fulfillment address. |
| (Optional) The ZIP or postal code of the fulfillment address. |
| (Optional) The 2-letter country code of the fulfillment address. |
| (Optional) The country name of the fulfillment address. |
| (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 `partial:partials/docs/shared/cl_transactionid.en-XC` |
PAYMENTREQUEST_n_ALLOWEDPAYMENTMETHOD | The payment method type. Specify the value |
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:
|
Payment Details Item Type Fields
EbayItemPaymentDetailsItemType Fields
Field | Description |
---|---|
L_PAYMENTREQUEST_n_EBAYITEMNUMBERm | Auction 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_EBAYITEMAUCTIONTXNIDm | Auction 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_EBAYITEMORDERIDm | Auction 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_EBAYITEMCARTIDm | The 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
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 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
PaymentErrorType Fields
Field | Description |
---|---|
PAYMENTREQUESTINFO_n_SHORTMESSAGE | Payment error short message. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive. |
PAYMENTREQUESTINFO_n_LONGMESSAGE | Payment error long message. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive. |
PAYMENTREQUESTINFO_n_ERRORCODE | Payment error code. You can specify up to ten payments, where n is a digit from 0 to 9, inclusive. |
PAYMENTREQUESTINFO_n_SEVERITYCODE | Payment 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
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 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 are deprecated. Replacement fields are noted when available.
Deprecated GetExpressCheckoutDetails Response Field
Field | Description |
---|---|
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:
|
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 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 |