GetTransactionDetails API Operation (NVP)
Shows information about a specific transaction.
GetTransactionDetails Request Message
GetTransactionDetails Request Fields
Field | Description |
---|---|
METHOD |
Must be GetTransactionDetails .
|
TRANSACTIONID |
(Required) Unique identifier of a transaction.
Note: The details for some kinds of transactions cannot be retrieved with Character length and limitations: 17 characters except for transactions of the type Order have a character length of 19. |
GetTransactionDetails Response Message
Note: All fields defined in the formal structure of
GetTransactionDetailsResponse
are not necessarily returned. Data are returned in a response only if PayPal has recorded data that corresponds to the field.
GetTransactionDetails Response Fields
Field | Description |
---|---|
SHIPPINGCALCULATIONMODE |
Describes how the options that were presented to the buyer were determined.
Value is:
|
INSURANCEOPTIONSELECTED |
Whether the buyer selected the insurance option. Value is:
The value |
L_SHIPPINGOPTIONISDEFAULTn |
Default shipping option displayed on the PayPal pages. This field is required if you specify the Callback URL. Value is:
Note: There must be ONE and ONLY ONE default. It is not OK to have no default. |
L_SHIPPINGOPTIONNAMEn |
Internal name of the shipping option such as Air, Ground, Expedited, and so forth. This field is required if you specify the Callback URL.
Character length and limitations: 50 character-string. |
L_SHIPPINGOPTIONAMOUNTn |
Amount of the flat rate shipping option. This field is required if you specify the Callback URL. Character length and limitations: Value is typically a positive number that cannot exceed |
GIFTMESSAGE |
The gift message the buyer entered on the PayPal pages.
Limitations: 100 single-byte characters |
GIFTRECEIPTENABLE |
Indicates whether a gift receipt widget is enabled on the PayPal pages. Value is:
|
GIFTWRAPNAME |
Label for the gift wrap option such as "Blue box with ribbon".
Limitations: 25 single-byte characters |
GIFTWRAPAMOUNT |
Amount to be charged to the buyer for the gift wrap. Character length and limitations: Value is typically a positive number that cannot exceed |
BUYERMARKETINGEMAIL |
The email address the buyer entered on the PayPal pages to be notified of promotions or special events.
Limitations: 127 single-byte characters |
SURVEYQUESTION |
Text for the survey question on the PayPal pages. If the survey question is present, at least 2 survey answer options need to be present.
Limitations: 50 single-byte characters |
SURVEYCHOICESELECTED |
Survey response the buyer selected on the PayPal pages.
Limitations: 15 single-byte characters |
Receiver Information Fields
Field | Description |
---|---|
RECEIVERBUSINESS |
Details about a single transaction. This field is not applicable for point-of-sale transactions. |
RECEIVEREMAIL |
Primary email address of the payment recipient (the merchant).
If you are the recipient of the payment and the payment is sent to your non-primary email address, the value of Receiver is still your primary email address. Character length and limitations: 127 single-byte alphanumeric characters |
RECEIVERID |
Unique account ID of the payment recipient (the merchant). This value is the same as the value of the recipient's referral ID. |
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 2-character country codes.
Character length and limitations: 2 single-byte characters |
PAYERBUSINESS |
Buyer's business name.
Character length and limitations: 127 single-byte characters |
Payer Name Fields
Field | Description |
---|---|
SALUTATION |
Buyer's salutation.
Character length and limitations: 20 single-byte characters |
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 Fields
Field | Description |
---|---|
ADDRESSOWNER |
eBay company that maintains this address. Value is:
|
ADDRESSSTATUS |
Status of street address on file with PayPal. Value is:
|
SHIPTOSECONDARYNAME |
Person's name associated with this secondary address.
Character length and limitations: 32 double-byte characters |
SHIPTONAME |
Person's name associated with this address.
Character length and limitations: 32 double-byte characters |
SHIPTOSTREET |
First street address.
Character length and limitations: 100 single-byte characters |
SHIPTOSECONDARYADDRESSLINE1 |
First line of street address for secondary address.
Character length and limitations: 100single-byte characters |
SHIPTOSTREET2 |
Second street address.
Character length and limitations: 100 single-byte characters |
SHIPTOSECONDARYADDRESSLINE2 |
Second line of street address for secondary address.
Character length and limitations: 100single-byte characters |
SHIPTOCITY |
Name of city.
Character length and limitations: 40 single-byte characters |
SHIPTOSECONDARYCITY |
Name of city for secondary address.
Character length and limitations: 40 single-byte characters |
SHIPTOSTATE |
State or province.
It is 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. Character length and limitations: 40 single-byte characters |
SHIPTOSECONDARYSTATE |
State or province for secondary address. Required for U.S. addresses only.
Character length and limitations: 40 single-byte characters |
SHIPTOZIP |
U.S. ZIP code or other country-specific postal code.
Character length and limitations: 20 single-byte characters |
SHIPTOSECONDARYZIP |
U.S. ZIP code or other country-specific postal code for secondary address.
Character length and limitations: 20 single-byte characters |
SHIPTOCOUNTRYCODE |
Country code.
Character length and limitations: 2 single-byte characters |
SHIPTOSECONDARYCOUNTRYCODE |
Country code for secondary addresss.
Character length and limitations: 2 single-byte characters |
SHIPTOPHONENUM |
Phone number.
Character length and limitations: 20 single-byte characters |
SHIPTOSECONDARYPHONENUM |
Phone number for secondary addresss.
Character length and limitations: 20 single-byte characters |
Payment Information Fields
Field | Description |
---|---|
TRANSACTIONID |
Unique transaction ID of the payment.
Character length and limitations: 17 characters except for transactions of the type Order have a character length of 19. |
PARENTTRANSACTIONID |
Parent or related transaction identification number. This value in this field is for the following transaction types:
Character length and limitations: 17 characters except for transactions of the type Order have a character length of 19. |
RECEIPTID |
Receipt identification number
Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format |
TRANSACTIONTYPE |
The type of transaction. Value is:
Character length and limitations:15 single-byte characters |
PAYMENTTYPE |
Indicates whether the payment is instant or delayed. Value is:
Character length and limitations: 7 single-byte characters |
ORDERTIME |
Date/time stamp of the payment. Character length and limitations: Date and time are in UTC/GMT format. For example, |
AMT |
The final amount charged, including any shipping and taxes from your Merchant Profile. Character length and limitations: Value is typically a positive number that cannot exceed |
CURRENCYCODE |
A 3-character currency code. |
FEEAMT |
PayPal fee amount charged for the transaction. Character length and limitations: Value is typically a positive number that cannot exceed |
SETTLEAMT |
Amount deposited in your PayPal account after a currency conversion. Character length and limitations: Value is typically a positive number that cannot exceed |
TAXAMT |
Tax charged on the transaction. Character length and limitations: Value is typically a positive number that cannot exceed |
EXCHANGERATE |
Exchange rate if a currency conversion occurred. Relevant only if your are billing in their non-primary currency. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the buyer's account.
Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point |
PAYMENTSTATUS |
Status of the payment. Value is:
|
PENDINGREASON |
The reason the payment is pending. Value is:
Note: |
REASONCODE |
The reason for a reversal if the transaction type is reversal. Value is:
|
PROTECTIONELIGIBILITY |
Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:
|
PROTECTIONELIGIBILITYTYPE |
Since version 64.4, the kind of seller protection in force for the transaction. It is one or more of the following values:
Note: If more than one of these values is returned in this field, they will be returned in a comma-delimited string; for example,
This field is available since version 64.4. |
STOREID |
StoreId as entered in the transaction. |
SUBJECT |
The value of the subject field entered by the buyer when making a payment. |
TERMINALID |
TerminalId as entered in the transaction. |
Payment Item Information Fields
Payment Item Fields
Field | Description |
---|---|
L_EBAYITEMTXNIDn |
(Optional) The eBay auction transaction ID of the item that you use to identify items that the buyer purchased.
Character length and limitations: 255 single-byte characters These parameters must be ordered sequentially beginning with 0 (for example |
L_NAMEn |
Item name set by you or entered by the customer.
Note: These parameters must be ordered sequentially beginning with 0 (for example |
L_NUMBERn |
Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_number variable, for example, item_number1 , item_number2 , and so forth.
Character length and limitations: 127 single-byte alphanumeric characters These parameters must be ordered sequentially beginning with 0 (for example |
L_QTYn |
Quantity set by you or entered by the buyer.
Character length and limitations: no limit |
L_ITEMCOUNTUNITn |
Unit of measure for the itemCount |
L_TAXABLEn |
Identifies whether this item is taxable or not. The default value is true. |
L_TAXRATEn |
The tax percentage applied to the item. This value is only displayed on the invoice. It is not used in pricing calculations. |
L_ADDITIONALFEESnTYPE |
Type of additional fees to the item |
L_ADDITIONALFEESnAMOUNT |
Amount of additional fees to the item |
L_ADDITIONALFEESnCURRENCY |
Currency of additional fees to the item |
L_MPNn |
Manufacturer part number of the item. |
L_ISBNn |
International Standard Book Number of the item
Character length and limits: 32 single-byte characters |
L_PLUn |
Price Look-Up code of the item
Character length and limits: 5 single-byte characters |
L_MODELNUMBERn |
Model number of the item
Character length and limits: 32 single-byte characters |
L_STYLENUMBERn |
Style number of the item
Character length and limits: 32 single-byte characters |
L_COUPONIDn |
(Optional) Coupon identification number. |
L_COUPONAMOUNTn |
(Optional) Amount (value) of the coupon. |
L_COUPONAMOUNTCURRENCYn |
(Optional) Currency of the coupon amount, e.g., a 3-character currency code. |
L_LOYALTYCARDDISCOUNTAMOUNTn |
(Optional) Amount of discount associated with this Loyalty Card incentive. 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 ( |
L_LOYALTYCARDISCOUNTCURRENCYn |
(Optional) Currency of the loyalty card discount, for example, a 3-character currency code. 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 ( |
L_AMTn |
Cost of item. These parameters must be ordered sequentially beginning with 0 (for example Character length and limitations: Value is typically a positive number that cannot exceed |
L_OPTIONSNAMEn |
PayPal option names for an item in the shopping cart; each name corresponds to an option value. There can be multiple option names per item.
The option names are ordered sequentially beginning with 0 (for example, |
L_OPTIONSVALUEn |
PayPal option values corresponding to option names of an item in the shopping cart.
The option names are ordered sequentially beginning with 0 (for example, |
Auction Information Fields
Field | Description |
---|---|
BUYERID |
Buyer's auction ID. |
CLOSINGDATE |
Auction's close date. |
MULTIITEM |
Counter used for multi-item auction payments. |
SubscriptionInfoType Fields
Field | Description |
---|---|
|
ID generated by PayPal for the subscriber. Character length and limitations: No limit |
|
Subscription start date. |
|
Date when the subscription modification is effective. |
|
Date PayPal retries a failed subscription payment. |
|
Username that PayPal generates and gives to the subscriber to access the subscription. Character length and limitations: 64 alphanumeric single-byte characters |
|
Password that PayPal generates and gives to the subscriber to access the subscription. For security, the value of the password is hashed. Character length and limitations: 128 alphanumeric single-byte characters |
|
The number of payment installments that occur at the regular rate. Character length and limitations: No limit |
|
Indicates whether reattempts should occur upon payment failures. |
|
Indicates whether regular rate recurs. Value is:
|
Subscription Terms Fields
Field | Description |
---|---|
AMOUNT |
Amount subscriber is to be charged in 1 payment.
Character length and limitations: No limit |
PERIOD |
Period of time that the subscriber is charged.
Character length and limitations: No limit |