GetTransactionDetails API Operation (SOAP)

Shows information about a specific transaction.

GetTransactionDetails Request Message

Note: Only the fields described in this documentation are available for use.

GetTransactionDetails Request Fields

Field Description

TransactionID

xs:string

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

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

PaymentTransaction Details

Wrapper structure.

ShippingCalculationMode

xs:string

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

xs:boolean

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.

ShippingOptionIsDefault

xs:boolean

Default shipping option displayed on the PayPal pages. This field is required if you specify the Callback URL. Value is:

  • true — This is the default flat-rate shipping option. PayPal displays this option by default.

  • false — This flat-rate shipping option is not displayed as the default.

Note: There must be ONE and ONLY ONE default. It is not OK to have no default.

ShippingOptionName

xs:string

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.

ShippingOptionAmount

ebl:BasicAmountType

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 10,000.00 USD 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.

GiftMessage

xs:string

The gift message the buyer entered on the PayPal pages.

Limitations: 100 single-byte characters

GiftReceiptEnable

xs:string

Indicates 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

xs:string

Label for the gift wrap option such as "Blue box with ribbon".

Limitations: 25 single-byte characters

GiftWrapAmount

ebl:BasicAmounttype

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

Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.

Character length and limitations:

Value is typically a positive number that cannot exceed 10,000.00 USD 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.

BuyerMarketingEmail

ebl:EmailAddressType

The email address the buyer entered on the PayPal pages to be notified of promotions or special events.

Limitations: 127 single-byte characters

SurveyQuestion

xs:string

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

xs:string

Survey response the buyer selected on the PayPal pages.

Limitations: 15 single-byte characters

PaymentTransactionDetailsType Fields

Field Description

ReceiverInfo

ebl:ReceiverInfoType

Information about the merchant, such as details of a single transaction, primary email address, and unique account ID.

PayerInfo

ebl:PayerInfoType

Information about the buyer, such as the buyer's email address, customer account identification number, shipping address, and country of residence.

TPLReferenceID

xs:string

Reference ID for the shipment sent from the merchant to the third-party shipping center.

This field is only provided as part of Global Shipping Platform (GSP) transactions.

This field is introduced in API version 95.0

PaymentInfo

ebl:PaymentInfoType

Information about the transaction, such as the transaction ID, the type of transaction, and whether the payment is instant or delayed.

PaymentItemInfo

ebl:PaymentItemInfoType

Information about the payment item, such as the sales tax, the invoice number, and whether the buyer left a note to the merchant.

SecondaryAddress

ns:AddressType

Information about the buyer's address in cases where the primary address is that of a shipping center.

This field is introduced in API version 93.0.

ReceiverInfoType Fields

Field Description

Business

xs:string

Details about a single transaction. This field is not applicable for point-of-sale transactions.

Receiver

xs:string

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

xs:string

Unique account ID of the payment recipient (the merchant). This value is the same as the value of the recipient's referral ID.

PayerInfoType Fields

Field Description

Payer

ebl:EmailAddressType

Email address of buyer.

Character length and limitations: 127 single-byte characters

PayerID

ebl:UserIDType

Unique PayPal Customer Account identification number.

Character length and limitations:13 single-byte alphanumeric characters

PayerStatus

ebl:PayPalUser StatusCodeType

Status of buyer. Value is:

  • verified

  • unverified

Character length and limitations: 10 single-byte alphabetic characters

PayerName

ebl:PersonNameType

First and last name of buyer.

PayerCountry

ebl:CountryCodeType

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

xs:string

Buyer's business name.

Character length and limitations: 127 single-byte characters

Address

ns:AddressType

Buyer's shipping address information.

PayerName Fields

Field Description

Salutation

xs:string

Buyer's salutation.

Character length and limitations: 20 single-byte characters

FirstName

ebl:PersonNameType

Buyer's first name.

Character length and limitations: 64 double-byte characters

MiddleName

ebl:NameUser

Buyer's middle name.

Character length and limitations: 64 double-byte characters

LastName

ebl:NameType

Buyer's last name.

Character length and limitations: 64 double-byte characters

Suffix

ebl:SuffixType

Buyer's suffix.

Character length and limitations: 12 single-byte characters

AddressType Fields

Field Description

AddressOwner

ebl:AddressOwnerTypeCode

eBay company that maintains this address. Value is:

  • eBay

  • PayPal

addressStatus

ebl:addressStatusTypeCode

Status of street address on file with PayPal. Value is:

  • none

  • Confirmed

  • Unconfirmed

Name

xs:string

Person's name associated with this address.

Character length and limitations: 32 double-byte characters

Street1

xs:string

First street address.

Character length and limitations: 100 single-byte characters

Street2

xs:string

Second street address.

Character length and limitations: 100 single-byte characters

CityName

xs:string

Name of city.

Character length and limitations: 40 single-byte characters

StateOrProvince

xs:string

State or province.

It is required for direct credit card transactions only if the address is in one of the following countries: Argentina, Brazil, Canada, China, Indonesia, India, Japan, Mexico, Thailand or USA, and it is required for Express Checkout transactions only if the address is a U.S. address. See the list of PayPal State codes.

Character length and limitations: 40 single-byte characters

PostalCode

xs:string

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

Character length and limitations: 20 single-byte characters

Country

ns:CountryCode

Country code.

Character length and limitations: 2 single-byte characters

CountryName

xs:string

Expanded name of country.

Character length and limitations: 64 single-byte alphanumeric characters

Phone

xs:string

Phone number.

Character length and limitations: 20 single-byte characters

PaymentInfoType Fields

Field Description

TransactionID

xs:string

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

xs:string

Parent or related transaction identification number. Thhe 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.

Character length and limitations: 17 characters except for transactions of the type Order have a character length of 19.

ReceiptID

xs:string

Receipt identification number

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

TransactionType

ns:PaymentTransactionCodeType

The type of transaction. Value is:

  • cart

  • express-checkout

Character length and limitations:15 single-byte characters

PaymentType

ebl:PaymentCodeType

Indicates whether the payment is instant or delayed. Value is:

  • none

  • echeck

  • instant

Character length and limitations: 7 single-byte characters

PaymentDate

xs:dateTime

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.

GrossAmount

ebl:BasicAmountType

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 10,000.00 USD 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.

FeeAmount

ebl:BasicAmountType

PayPal fee amount charged for the transaction.

Character length and limitations:

Value is typically a positive number that cannot exceed 10,000.00 USD 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.

SettleAmount

ebl:BasicAmountType

Amount deposited in your PayPal account after a currency conversion.

Character length and limitations:

Value is typically a positive number that cannot exceed 10,000.00 USD 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.

TaxAmount

ebl:BasicAmountType

Tax charged on the transaction.

Character length and limitations:

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

ExchangeRate

xs:string

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

ebl:PaymentStatusCodeType

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

PendingReason

ebl:PendingStatusCodeType

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

  • payment-review — The payment is pending while it is being reviewed by PayPal for risk.

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

ReasonCode

ebl:ReasonCodeType

The 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 customer dispute in which an unauthorized spoof is suspected.
  • other — A reversal has occurred on this transaction due to a reason not listed above.

ProtectionEligibility

xs:string

Prior 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

xs:string

Since version 64.4, the kind of seller protection in force for the transaction.

It is one or more of the following values:

  • 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 will be returned in a comma-delimited string; for example, ItemNotReceivedEligible,UnauthorizedPaymentEligible.

This field is available since version 64.4.

StoreId

xs:string

StoreId as entered in the transaction.

Subject

xs:string

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

TerminalId

xs:string

TerminalId as entered in the transaction.

PaymentItemInfoType Fields

Field Description

InvoiceID

xs:string

Invoice number you set in the original transaction.

Character length and limitations: 256 single-byte alphanumeric characters

Custom

xs:string

Custom field you set in the original transaction.

Character length and limitations: 256 single-byte alphanumeric characters

Memo

xs:string

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

Character length and limitations: 255 single-byte alphanumeric characters

SalesTax

xs:string

Amount of tax charged on payment.

PaymentItem

ebl:PaymentItemType

Amount of tax charged on payment.

Subscription

ebl:SubscriptionInfoType

Subscription information.

Auction

ebl:AuctionInfoType

Subscription information.

SoftDescriptor

(Optional) Information that is usually displayed in the account holder's statement, for example, <Your-Not-For-Profit> <State>, <Your-Not-For-Profit> <Branch-Name>, <Your-Website> dues or <Your-Website> list fee.

Character length and limitations: 23 alphanumeric characters, can include the special characters dash (-) and dot (.) only. Asterisks (*) are NOT permitted. If it includes a space character (), enclose the "<Soft-Descriptor>" value in double quotes.

PaymentItemType Fields

Field Description

EbayItemTxnId

xs:string

(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

Name

xs:string

Item name set by you or entered by the customer.

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

Number

xs:string

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

Quantity

xs:string

Quantity set by you or entered by the buyer.

Character length and limitations: no limit

InvoiceItemDetails

ns:InvoiceItemType

Describes an individual item in an invoice. See InvoiceItemType for details.

CouponID

xs:string

(Optional) Coupon identification number.

CouponAmount

xs:string

(Optional) Amount (value) of the coupon.

CouponAmountCurrency

xs:string

(Optional) Currency of the coupon amount, e.g., a 3-character currency code.

LoyaltyCardDiscountAmount

xs:string

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

LoyaltyCardDiscountCurrency

xs:string

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

Amount

ebl:BasicAmountType

Cost of item.

Options

ns:OptionType

name: xs:string

value: xs:string

PayPal item options for shopping cart.

AuctionInfoType Fields

Field Description

BuyerID

xs:string

Buyer's auction ID.

ClosingDate

xs:string

Auction's close date.

MultiItem

xs:string

Counter used for multi-item auction payments.

InvoiceItemType Fields

ItemCountUnit ns:UnitOfMeasure
Unit of measure for the ItemCount
Taxable xs:boolean
Identifies whether this item is taxable or not. The default value is true.
TaxRate xs:double
The tax percentage applied to the item. This value is only displayed on the receipt. It is not used in pricing calculations.
AdditionalFees ns:AdditionalFeeType
Additional fees applied to this item
MPN xs:string
Manufacturer part number
ISBN xs:string
International Standard Book Number
Character length and limits: 32 single-byte characters
PLU xs:string
Price Look-Up code
Character length and limits: 5 single-byte characters
ModelNumber xs:string
Model number of the item
Character length and limits: 32 single-byte characters
StyleNumber xs:string
Style number of the item
Character length and limits: 32 single-byte characters

SubscriptionInfoType Fields

Field Description

SubscriptionID

xs:string

ID generated by PayPal for the subscriber.

Character length and limitations: No limit

SubscriptionDate

xs:dateTime

Subscription start date.

EffectiveDate

xs:dateTime

Date when the subscription modification is effective.

RetryTime

xs:dateTime

Date PayPal retries a failed subscription payment.

UserName

xs:string

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

Character length and limitations: 64 alphanumeric single-byte characters

Password

xs:string

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

Recurrences

xs:string

The number of payment installments that occur at the regular rate.

Character length and limitations: No limit

reattempt

xs:string

Indicates whether reattempts should occur upon payment failures.

recurring

xs:string

Indicates whether regular rate recurs. Value is:


  • 1 — Yes

SubscriptionTermsType

ns:SubscriptionTermsType

Subscription terms.

SubscriptionTermsType Fields

Field Description

Amount

eb:BasicAmountType

Amount subscriber is to be charged in 1 payment.

Character length and limitations: No limit

Period

xs:string

Period of time that the subscriber is charged.

Character length and limitations: No limit

AuctionInfoType Fields

Use the attribute multiItem as a counter for multi-item auction payments.

Field Description
BuyerID

xs:string

Buyer's auction ID.

ClosingDate

xs:string

Auction's close date.