GetTransactionDetails API Operation (NVP)

Note: The details for some kinds of transactions cannot be retrieved with GetTransactionDetails. You cannot obtain details of bank transfer withdrawals, for example.

Value is:

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

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

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

Character length and limitations: 50 character-string.

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

Limitations: 100 single-byte characters

• 0 — Do not enable gift receipt widget.
• 1 — Enable gift receipt widget.

Limitations: 25 single-byte characters

Amount to be charged to the buyer for the gift wrap.

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.

Limitations: 127 single-byte characters

Limitations: 50 single-byte characters

Limitations: 15 single-byte characters

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

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

• eBay
• PayPal

• none
• Confirmed
• Unconfirmed

Character length and limitations: 32 double-byte characters

Character length and limitations: 32 double-byte characters

Character length and limitations: 100 single-byte characters

Character length and limitations: 100single-byte characters

Character length and limitations: 100 single-byte characters

Character length and limitations: 100single-byte characters

Character length and limitations: 40 single-byte characters

Character length and limitations: 40 single-byte characters

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

Character length and limitations: 40 single-byte characters

Character length and limitations: 20 single-byte characters

Character length and limitations: 20 single-byte characters

Character length and limitations: 2 single-byte characters

Character length and limitations: 2 single-byte characters

Character length and limitations: 20 single-byte characters

Character length and limitations: 20 single-byte characters

Character length and limitations: 17 characters. Orders transactions have 19 characters.

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

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

• cart
• express-checkout

Character length and limitations:15 single-byte characters

• none
• echeck
• instant

Character length and limitations: 7 single-byte characters

Date/time stamp of the payment.

Character length and limitations: Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

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

PayPal fee amount charged for the transaction.

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.

Amount deposited in your PayPal account after a currency conversion.

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.

Tax charged on the transaction.

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.

Character length and limitations: Decimal value that does not exceed 17 characters, including decimal point

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

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

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

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

• ItemNotReceivedEligible – Merchant is protected by PayPal's Seller Protection Policy for Item Not Received.
• UnauthorizedPaymentEligible – Merchant is protected by PayPal's Seller Protection Policy for Unauthorized Payment.
• Ineligible – Merchant is not protected under the Seller Protection Policy.

Note:

If more than one of these values is returned in this field, they are returned in a comma-delimited string; for example, ItemNotReceivedEligible,UnauthorizedPaymentEligible.

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

Character length and limitations: 256 single-byte alphanumeric characters

Character length and limitations: 256 single-byte alphanumeric characters

Character length and limitations: 255 single-byte alphanumeric characters

Note:

For US Website Payments Pro AMEX cards only and only for merchants passing dynamic soft descriptors, the dynamic soft descriptors for AMEX cards are only guaranteed once the transaction settles. This means that during the authorization time the card issuing bank might show their customer the registered business or legal name for the merchant versus the dynamic soft descriptor passed on a per API transaction.

Character length and limitations: 255 single-byte characters

These parameters must be ordered sequentially beginning with 0 (for example L_EBAYITEMTXNID0, L_EBAYITEMTXNID1).

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

Character length and limitations: 127 single-byte alphanumeric characters

These parameters must be ordered sequentially beginning with 0 (for example L_NUMBER0, L_NUMBER1).

Character length and limitations: no limit

Character length and limits: 32 single-byte characters

Character length and limits: 5 single-byte characters

Character length and limits: 32 single-byte characters

Character length and limits: 32 single-byte characters

(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 (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

(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 (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. See the currency codes page for details.

Cost of item.

These parameters must be ordered sequentially beginning with 0 (for example L_AMT0, L_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.

The option names are ordered sequentially beginning with 0 (for example, L_OPTIONSNAMES0, L_OPTIONSNAME1).

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

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

Character length and limitations: No limit

Character length and limitations: No limit