GetTransactionDetails API Operation (NVP)

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


Shows information about a specific transaction.

Important: This integration method is deprecated as of January 1, 2017. PayPal continues to support existing merchants using this method, but please be advised new features and enhancements will not be applied to these integrations. For new integrations, see the PayPal Checkout Integration Guide.

GetTransactionDetails Request Message

GetTransactionDetails Request Fields

FieldDescription
METHODMust be GetTransactionDetails.
TRANSACTIONID(Required) Unique identifier of a transaction.
Note: The details for some kinds of transactions cannot be retrieved with GetTransactionDetails. You cannot obtain details of bank transfer withdrawals, for example.
`partial:partials/docs/shared/cl_transactionid.en-XC`

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

FieldDescription
SHIPPINGCALCULATIONMODE Describes how the options that were presented to the buyer were determined.

Value is:

  • Callback — Shipping option rates are based on the buyer's location.
  • FlatRate — Shipping options are flat rates.

INSURANCEOPTIONSELECTED Whether the buyer selected the insurance option. Value is:
  • true — The buyer selected Yes for the insurance option.
  • false — The buyer did not select the insurance option. The option is No.

The value true is returned if the buyer selected the option. Otherwise false is returned.

L_SHIPPINGOPTIONISDEFAULTn(Required) The default shipping option that appears on the PayPal pages. This field is required if you specify the callback URL. Value is:
  • true — The default. PayPal displays this flat-rate shipping option and its amount as the default shipping option.
  • false — PayPal does not display this flat-rate shipping option and its amount as the default shipping option. If you specify false, you can adjust either or both of these values:
    • PAYMENTREQUEST_n_TAXAMT.

    • PAYMENTREQUEST_n_INSURANCEAMT.

Note: You must specify one and only one default shipping option.
L_SHIPPINGOPTIONNAMEnInternal 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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

GIFTMESSAGEThe gift message the buyer entered on the PayPal pages.

Limitations: 100 single-byte characters

GIFTRECEIPTENABLEIndicates whether a gift receipt widget is enabled on the PayPal pages. Value is:
  • 0 — Do not enable gift receipt widget.
  • 1 — Enable gift receipt widget.
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: `partial:partials/docs/shared/cl_currencylimit.en-XC`

BUYERMARKETINGEMAILThe 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

SURVEYCHOICESELECTEDSurvey response the buyer selected on the PayPal pages.

Limitations: 15 single-byte characters

Receiver Information Fields

FieldDescription
RECEIVERBUSINESSDetails about a single transaction. This field is not applicable for point-of-sale transactions.
RECEIVEREMAILPrimary 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

RECEIVERIDUnique 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

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 2-character country codes.

Character length and limitations: 2 single-byte characters

PAYERBUSINESSBuyer's business name.

Character length and limitations: 127 single-byte characters

Payer Name Fields

FieldDescription
SALUTATIONBuyer's salutation.

Character length and limitations: 20 single-byte characters

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 Fields

FieldDescription
ADDRESSOWNEReBay company that maintains this address. Value is:
  • eBay
  • PayPal
ADDRESSSTATUSStatus of street address on file with PayPal. Value is:
  • none
  • Confirmed
  • Unconfirmed
SHIPTOSECONDARYNAMEPerson's name associated with this secondary address.

Character length and limitations: 32 double-byte characters

SHIPTONAMEPerson's name associated with this address.

Character length and limitations: 32 double-byte characters

SHIPTOSTREETFirst street address.

Character length and limitations: 100 single-byte characters

SHIPTOSECONDARYADDRESSLINE1First line of street address for secondary address.

Character length and limitations: 100single-byte characters

SHIPTOSTREET2Second street address.

Character length and limitations: 100 single-byte characters

SHIPTOSECONDARYADDRESSLINE2Second line of street address for secondary address.

Character length and limitations: 100single-byte characters

SHIPTOCITYName of city.

Character length and limitations: 40 single-byte characters

SHIPTOSECONDARYCITYName of city for secondary address.

Character length and limitations: 40 single-byte characters

SHIPTOSTATEState or province.

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

Character length and limitations: 40 single-byte characters

SHIPTOSECONDARYSTATEState or province for secondary address. Required for U.S. addresses only.

Character length and limitations: 40 single-byte characters

SHIPTOZIPU.S. ZIP code or other country-specific postal code.

Character length and limitations: 20 single-byte characters

SHIPTOSECONDARYZIPU.S. ZIP code or other country-specific postal code for secondary address.

Character length and limitations: 20 single-byte characters

SHIPTOCOUNTRYCODECountry code.

Character length and limitations: 2 single-byte characters

SHIPTOSECONDARYCOUNTRYCODECountry code for secondary addresss.

Character length and limitations: 2 single-byte characters

SHIPTOPHONENUMPhone number.

Character length and limitations: 20 single-byte characters

SHIPTOSECONDARYPHONENUMPhone number for secondary addresss.

Character length and limitations: 20 single-byte characters

Payment Information Fields

FieldDescription
TRANSACTIONIDUnique transaction ID of the payment.

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

PARENTTRANSACTIONIDParent or related transaction identification number. This value in this field is for the following transaction types:
  • Reversal — Capture of an authorized transaction.
  • Reversal — Reauthorization of a transaction.
  • Capture of an order — The value of ParentTransactionID is the original OrderID.
  • Authorization of an order — The value of ParentTransactionID is the original OrderID.
  • Capture of an order authorization.
  • Void of an order — The value of ParentTransactionID is the original OrderID.
`partial:partials/docs/shared/cl_transactionid.en-XC`
RECEIPTIDReceipt identification number

Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format

TRANSACTIONTYPEThe type of transaction. Value is:
  • cart
  • express-checkout

Character length and limitations:15 single-byte characters

PAYMENTTYPEIndicates whether the payment is instant or delayed. Value is:
  • none
  • echeck
  • instant

Character length and limitations: 7 single-byte characters

ORDERTIME

Date/time stamp of the payment.

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

AMT

The final amount charged, including any shipping and taxes from your Merchant Profile.

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

CURRENCYCODEA 3-character currency code.
FEEAMT

PayPal fee amount charged for the transaction.

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

SETTLEAMT

Amount deposited in your PayPal account after a currency conversion.

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

TAXAMT

Tax charged on the transaction.

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

EXCHANGERATEExchange 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

PAYMENTSTATUSStatus of the payment. Value is:
  • None — No status
  • Canceled-Reversal — A reversal has been canceled, for example, when you win a dispute and the funds for the reversal have been returned to you.
  • Completed — The payment has been completed, and the funds have been added successfully to your account balance.
  • Denied — You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element.
  • Expired — The authorization period for this payment has been reached.
  • Failed — The payment has failed. This happens only if the payment was made from your buyer's bank account.
  • In-Progress — The transaction has not terminated, for example, an authorization may be awaiting completion.
  • Partially-Refunded — The payment has been partially refunded.
  • Pending — The payment is pending. See the PendingReason field for more information.
  • Refunded — You refunded the payment.
  • Reversed — A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer. The reason for the reversal is specified in the ReasonCode element.
  • Processed — A payment has been accepted.
  • Voided — An authorization for this transaction has been voided.
PENDINGREASONThe reason the payment is pending. Value is:
  • none — No pending reason.
  • address — The payment is pending because your buyer did not include a confirmed shipping address and your Payment Receiving Preferences is set such that you want to manually accept or deny each of these payments. To change your preference, go to the Preferences section of your Profile.
  • authorization — The payment is pending because it has been authorized but not settled. You must capture the funds first.
  • echeck — The payment is pending because it was made by an eCheck that has not yet cleared.
  • intl — The payment is pending because you hold a non-U.S. account and do not have a withdrawal mechanism. You must manually accept or deny this payment from your Account Overview.
  • multi-currency — You do not have a balance in the currency sent, and you do not have your Payment Receiving Preferences set to automatically convert and accept this payment. You must manually accept or deny this payment.
  • order — The payment is pending because it is part of an order that has been authorized but not settled.
  • paymentreview — The payment is pending while it is being reviewed by PayPal for risk.
  • regulatoryreview - The payment is pending while we make sure it meets regulatory requirements. You will be contacted again in 24-72 hours with the outcome of the review.
  • unilateral — The payment is pending because it was made to an email address that is not yet registered or confirmed.
  • verify —The payment is pending because you are not yet verified. You must verify your account before you can accept this payment.
  • other — The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.
Note: PendingReason is returned in the response only if PaymentStatus is Pending.
REASONCODEThe reason for a reversal if the transaction type is reversal. Value is:
  • None — No reason code.

  • adjustment_reversal — Reversal of an adjustment.
  • admin_fraud_reversal — The transaction has been reversed due to fraud detected by PayPal administrators.
  • admin_reversal — The transaction has been reversed by PayPal administrators.
  • buyercomplaint — A reversal has occurred on this transaction due to a complaint about the transaction from your buyer.

  • chargeback — A reversal has occurred on this transaction due to a chargeback by your buyer.

  • chargeback_reimbursement — Reimbursement for a chargeback.
  • chargeback_settlement — Settlement of a chargeback.
  • guarantee — A reversal has occurred on this transaction due to your buyer triggering a money-back guarantee.

  • refund — A reversal has occurred on this transaction because you have given the buyer a refund.

  • regulatory_block — PayPal blocked the transaction due to a violation of a government regulation. In this case, payment_status is Denied.
  • regulatory_reject — PayPal rejected the transaction due to a violation of a government regulation and returned the funds to the buyer. In this case, payment_status is Denied.
  • regulatory_review_exceeding_sla — PayPal did not complete the review for compliance with government regulations within 72 hours, as required. Consequently, PayPal auto-reversed the transaction and returned the funds to the buyer. In this case, payment_status is Denied. Note that “sla” stands for “service level agreement.”
  • unauthorized_claim — The transaction has been reversed because it was not authorized by the buyer.
  • unauthorized_spoof — The transaction has been reversed due to a dispute in which an unauthorized spoof is suspected.
  • other — A reversal has occurred on this transaction due to a reason not listed above.

PROTECTIONELIGIBILITYPrior to version 64.4, the kind of seller protection in force for the transaction. Value is:
  • Eligible — Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payments and Item Not Received.
  • PartiallyEligible — Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
  • Ineligible — Merchant is not protected under the Seller Protection Policy.
PROTECTIONELIGIBILITYTYPE`partial:partials/docs/shared/cl_protectioneligibilitytype.en-XC`
STOREIDStoreId as entered in the transaction.
SUBJECT

The value of the subject field entered by the buyer when making a payment.

TERMINALIDTerminalId as entered in the transaction.

Payment Item Information Fields

FieldDescription
INVNUMInvoice number you set in the original transaction.

Character length and limitations: 256 single-byte alphanumeric characters

CUSTOMCustom field you set in the original transaction.

Character length and limitations: 256 single-byte alphanumeric characters

NOTEMemo entered by your customer in PayPal Website Payments note field.

Character length and limitations: 255 single-byte alphanumeric characters

SALESTAXAmount of tax charged on payment.
SOFTDESCRIPTOR`partial:partials/docs/shared/cl_softdescriptor_cc.en-XC`

Payment Item Fields

FieldDescription
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_EBAYITEMTXNID0, L_EBAYITEMTXNID1).

L_NAMEnItem name set by you or entered by the customer.
Note:

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

These parameters must be ordered sequentially beginning with 0 (for example L_NAME0, L_NAME1).

L_NUMBERnItem 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_NUMBER0, L_NUMBER1).

L_QTYnQuantity set by you or entered by the buyer.

Character length and limitations: no limit

L_ITEMCOUNTUNITnUnit of measure for the itemCount
L_TAXABLEnIdentifies whether this item is taxable or not. The default value is true.
L_TAXRATEnThe tax percentage applied to the item. This value is only displayed on the invoice. It is not used in pricing calculations.
L_ADDITIONALFEESnTYPEType of additional fees to the item
L_ADDITIONALFEESnAMOUNTAmount of additional fees to the item
L_ADDITIONALFEESnCURRENCYCurrency of additional fees to the item
L_MPNnManufacturer part number of the item.
L_ISBNnInternational Standard Book Number of the item

Character length and limits: 32 single-byte characters

L_PLUnPrice Look-Up code of the item

Character length and limits: 5 single-byte characters

L_MODELNUMBERnModel number of the item

Character length and limits: 32 single-byte characters

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

L_LOYALTYCARDDISCOUNTCURRENCYn

(Optional) Currency of the loyalty card discount, for example, a 3-character currency code.

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

L_AMTn

Cost of item.

These parameters must be ordered sequentially beginning with 0 (for example L_AMT0, L_AMT1).

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

L_OPTIONSNAMEnPayPal 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_OPTIONSNAMES0, L_OPTIONSNAME1).

L_OPTIONSVALUEnPayPal option values corresponding to option names of an item in the shopping cart.

The option names are ordered sequentially beginning with 0 (for example, L_OPTIONSVALUE0, L_OPTIONSVALUE1).

Auction Information Fields

FieldDescription
BUYERIDBuyer's auction ID.
CLOSINGDATEAuction's close date.
MULTIITEMCounter used for multi-item auction payments.

SubscriptionInfoType Fields

Field Description

SUBSCRIPTIONID

xs:string

ID generated by PayPal for the subscriber.

Character length and limitations: No limit

SUBSCRIPTIONDATE

Subscription start date.

EFFECTIVEDATE

Date when the subscription modification is effective.

RETRYTIME

Date PayPal retries a failed subscription payment.

USERNAME

Username that PayPal generates and gives to the subscriber to access the subscription.

Character length and limitations: 64 alphanumeric single-byte characters

PASSWORD

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

REATTEMPT

Indicates whether reattempts should occur upon payment failures.

RECURRING

Indicates whether regular rate recurs. Value is:

  • 1 — Yes

Subscription Terms Fields

FieldDescription
AMOUNTAmount subscriber is to be charged in 1 payment.

Character length and limitations: No limit

PERIODPeriod of time that the subscriber is charged.

Character length and limitations: No limit