GetTransactionDetails API Operation (SOAP)
Last updated: Aug 15th, 6:10am
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
Note: Only the fields described in this documentation are available for use.
GetTransactionDetails Request Fields
Field | Description |
---|---|
|
(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. |
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 |
---|---|
| Wrapper structure. |
|
Describes how the options that were presented to the buyer were determined. Value is:
|
|
Whether the buyer selected the insurance option. Value is:
The value |
|
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. |
|
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. |
|
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 ( |
|
The gift message the buyer entered on the PayPal pages. Limitations: 100 single-byte characters |
|
Indicates whether a gift receipt widget is enabled on the PayPal pages. Value is:
|
|
Label for the gift wrap option such as "Blue box with ribbon". Limitations: 25 single-byte characters |
|
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 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 ( |
|
The email address the buyer entered on the PayPal pages to be notified of promotions or special events. Limitations: 127 single-byte characters |
|
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 |
|
Survey response the buyer selected on the PayPal pages. Limitations: 15 single-byte characters |
PaymentTransactionDetailsType Fields
Field | Description |
---|---|
|
Information about the merchant, such as details of a single transaction, primary email address, and unique account ID. |
|
Information about the buyer, such as the buyer's email address, customer account identification number, shipping address, and country of residence. |
|
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 |
|
Information about the transaction, such as the transaction ID, the type of transaction, and whether the payment is instant or delayed. |
|
Information about the payment item, such as the sales tax, the invoice number, and whether the buyer left a note to the merchant. |
|
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 |
---|---|
|
Details about a single transaction. This field is not applicable for point-of-sale transactions. |
|
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 |
|
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 |
---|---|
|
Email address of buyer. Character length and limitations: 127 single-byte characters |
|
Unique PayPal Customer Account identification number. Character length and limitations:13 single-byte alphanumeric characters |
|
Status of buyer. Value is:
Character length and limitations: 10 single-byte alphabetic characters |
|
First and last name of buyer. |
|
Buyer's country of residence in the form of ISO standard 3166 2-character country codes. Character length and limitations: 2 single-byte characters |
|
Buyer's business name. Character length and limitations: 127 single-byte characters |
|
Buyer's shipping address information. |
PayerName Fields
Field | Description |
---|---|
|
Buyer's salutation. Character length and limitations: 20 single-byte characters |
|
Buyer's first name. Character length and limitations: 64 double-byte characters |
|
Buyer's middle name. Character length and limitations: 64 double-byte characters |
|
Buyer's last name. Character length and limitations: 64 double-byte characters |
|
Buyer's suffix. Character length and limitations: 12 single-byte characters |
AddressType Fields
Field | Description |
---|---|
|
eBay company that maintains this address. Value is:
|
|
Status of street address on file with PayPal. Value is:
|
|
Person's name associated with this address. Character length and limitations: 32 double-byte characters |
|
First street address. Character length and limitations: 100 single-byte characters |
|
Second street address. Character length and limitations: 100 single-byte characters |
|
Name of city. Character length and limitations: 40 single-byte characters |
|
State or province. Character length and limitations: 40 single-byte characters |
|
U.S. ZIP code or other country-specific postal code. Character length and limitations: 20 single-byte characters |
|
Country code. Character length and limitations: 2 single-byte characters |
|
Expanded name of country. Character length and limitations: 64 single-byte alphanumeric characters |
|
Phone number. Character length and limitations: 20 single-byte characters |
PaymentInfoType Fields
Field | Description |
---|---|
|
Unique transaction ID of the payment. Character length and limitations: 17 characters. Orders transactions have 19 characters. |
|
Parent or related transaction identification number. Thhe value in this field is for the following transaction types:
|
|
Receipt identification number Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format |
|
The type of transaction. Value is:
Character length and limitations:15 single-byte characters |
|
Indicates whether the payment is instant or delayed. Value is:
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, |
|
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 ( |
|
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 ( |
|
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 ( |
|
Tax charged on the transaction. Character length and limitations: Date and time are in UTC/GMT format. For example, |
|
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 |
|
Status of the payment. Value is:
|
|
The reason the payment is pending. Value is:
Note: PendingReason is returned in the response only if PaymentStatus is Pending . |
|
The reason for a reversal if the transaction type is reversal. Value is:
|
|
Prior to version 64.4, the kind of seller protection in force for the transaction. Value is:
|
|
It is one or more of the following values:
Note: If more than one of these values is returned in this field, they are returned in a comma-delimited string; for example, |
|
StoreId as entered in the transaction. |
|
The value of the subject field entered by the buyer when making a payment. |
|
TerminalId as entered in the transaction. |
PaymentItemInfoType Fields
PaymentItemType Fields
Field | Description |
---|---|
|
(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 |
|
Item name set by you or entered by the customer. Note: Character length and limitations: 127 single-byte alphanumeric characters. |
|
Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML Character length and limitations: 127 single-byte alphanumeric characters |
|
Quantity set by you or entered by the buyer. Character length and limitations: no limit |
|
Describes an individual item in an invoice. See InvoiceItemType for details. |
|
(Optional) Coupon identification number. |
|
(Optional) Amount (value) of the coupon. |
|
(Optional) Currency of the coupon amount, e.g., a 3-character currency code. |
|
(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 ( |
|
(Optional) Currency of the loyalty card discount, for example, a 3-character currency code. |
|
Cost of item. |
|
PayPal item options for shopping cart. |
AuctionInfoType Fields
Field | Description |
---|---|
|
Buyer's auction ID. |
|
Auction's close date. |
|
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 |
---|---|
|
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 |
|
Indicates whether reattempts should occur upon payment failures. |
|
Indicates whether regular rate recurs. Value is:
|
|
Subscription terms. |
SubscriptionTermsType Fields
Field | Description |
---|---|
|
Amount subscriber is to be charged in 1 payment. Character length and limitations: No limit |
|
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 |
Buyer's auction ID. |
ClosingDate |
Auction's close date. |