GetExpressCheckoutDetails API Operation (NVP)

(Required) Must be GetExpressCheckoutDetails.

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

Character length and limitations: 20 single-byte characters.

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

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

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.

Value is:

• 0. Not accepted.
• 1. Accepted.

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

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.

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.

Character length and limitations: 127 single-byte characters.

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

• verified
• unverified

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

Character length and limitations: 2 single-byte characters.

Character length and limitations: 127 single-byte characters.

Character length and limitations: 64 double-byte characters.

Character length and limitations: 64 double-byte characters.

Character length and limitations: 64 double-byte characters.

Character length and limitations: 12 single-byte characters.

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.

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.

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.

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.

State or province.

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

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.

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.

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.

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.

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.

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

The PayPal address normalization status for Brazilian addresses. It can have one of the following values:

• None
• Normalized
• Unnormalized
• UserPreferred

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

Character length and limitations: Three single-byte characters.

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.

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.

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

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.

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.

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.

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.

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.

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

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

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.

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.

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.

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

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

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

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

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

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

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.

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.

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.

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.

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.

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.

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

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

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.

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

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.

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.

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

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.

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.

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.

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.

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.

Character length: 765 single-byte characters.

Character length: 255 single-byte characters.

Character length: 64 single-byte characters.

Character length: 255 single-byte characters.

• API – Callback
• API – Flatrate

• Yes. The buyer opted for insurance.
• No. The buyer did not opt for insurance.

• true. The buyer chose the default shipping option.
• false. The buyer did not choose the default shipping option.

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

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.

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.

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

Character length and limitations: 17 characters. Orders transactions have 19 characters. This field is available since version 64.0.

This field is available since version 64.0.

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.

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.

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.

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.

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.

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

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

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.

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

Survey question on the PayPal checkout pages.

Character length and limitations: 50 single-byte.

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

Survey response the buyer selects on the PayPal pages.

Character length and limitations: 15 single-byte characters.

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