GetTransactionDetails API

 

The GetTransactionDetails API retrieves information about a single transaction.

Diagram of GetTransactionDetails Types

The following diagram represents the composition of the GetTransactionDetailsRequestType and GetTransactionDetailsResponseType elements.

Figure 6.1

GetTransactionDetails Types

 

GetTransactionDetailsRequest

Get details about a transaction.

Table 6.1

GetTransactionDetailsRequest Fields

Field	Description	Required?
TransactionID	xs:string 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 single-byte alphanumeric characters	Yes

GetTransactionDetailsResponse

Response to GetTransactionDetailsRequest.

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.

For error codes and messages and their meanings, see Appendix A, “Error Codes and Messages for All PayPal APIs.”

Table 6.2

GetTransactionDetailsResponse Fields

Field	Included Element	Description	Data Type and Possible Values
Payment Transaction Details	ReceiverInfo PayerInfo PaymentInfo PaymentItem Info	Wrapper structure
ReceiverInfo		Includes elements described below	ebl:ReceiverInfoType
	Business	Email address or account ID of the payment recipient (the seller). Equivalent to Receiver if payment is sent to primary account. Character length and limitations: 127 single-byte alphanumeric characters	xs:string
	Receiver	Primary email address of the payment recipient (the seller). 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	xs:string
	ReceiverID	Unique account ID of the payment recipient (the seller). This value is the same as the value of the recipient's referral ID.	xs:string
PayerInfo		Includes elements described below	ebl:PayerInfo Type
	Payer	Email address of payer Character length and limitations: 127 single-byte characters	ns:EmailAddress Type
	PayerID	Unique customer ID. Character length and limitations: 13 single-byte alphanumeric characters.	ebl:UserIDType
	PayerStatus	Status of payer’s email address: Verified Unverified	ebl:PayPalUser StatusCodeType Verified Unverified
PayerName (included in PayerInfo)	Salutation	Payer’s salutation Character length and limitations: 20 single-byte characters	xs:string
	FirstName	Payer’s first name Character length and limitations: 25 single-byte characters	ebl:NameType
	MiddleName	Payer’s middle name Character length and limitations: 25 single-byte characters	ebl:NameType
	LastName	Payer’s last name Character length and limitations: 25 single-byte characters	ebl:NameType
	Suffix	Payer’s suffix Character length and limitations: 12 single-byte characters	ebl:SuffixType
	PayerCountry	Payment sender’s country of residence using standard two-character ISO 3166 country codes. Character length and limitations: Two single-byte characters	ebl:CountryCode Type
	PayerBusiness	Payer’s business name. Character length and limitations: 127 single-byte characters	xs:string
Address (included in PayerInfo)		Includes the following elements.	ebl:AddressType
	AddressOwner	eBay company that maintains this address	ebl:AddressOwnerTypeCode xs:token eBay PayPal
	AddressStatus	Status of the address on file with PayPal: None Confirmed Unconfirmed	ebl:Address Status CodeType xs:token None Confirmed Unconfirmed
	Name	Person’s name associated with this address. Character length and limitations: 32 single-byte alphanumeric characters	xs:string
	Street1	First street address. Character length and limitations: 300 single-byte alphanumeric characters	xs:string
	Street2	Second street address. Character length and limitations: 300 single-byte alphanumeric characters	xs:string
	CityName	Name of city. Character length and limitations: 120 single-byte alphanumeric characters	xs:string
	StateOr Province	State or province. Character length and limitations: 120 single-byte alphanumeric characters See Appendix E, “State and Province Abbreviations.”	xs:string
	Country	Payer’s “ship to” country as standard two-character ISO 3166 country code. Character length and limitations: Two single-byte characters	ns:Country
	CountryName	Expanded name of country. Character length and limitations: 64 single-byte alphanumeric characters	xs:string
	Phone	Phone number associated with this address	xs:string
	PostalCode	Postal code	xs:string
PaymentInfo		Includes the following elements.	ebl:PaymentInfo Type
	Parent TransactionID	Original transaction to which this transaction is related. This field is populated for the following transaction types: l Reversal l Capture of an authorized transaction. l Reauthorization of a transaction. l Capture of an order. The value of ParentTransactionID is the original OrderID. l Authorization of an order. The value of ParentTransactionID is the original OrderID. l Capture of an order authorization. l Void of an order. The value of ParentTransactionID is the original OrderID. Character length and limitations: 19 single-byte characters	xs:string
	TransactionID	PayPal transaction identification number Character length and limitations: 19 single-byte characters	xs:string
	ReceiptID	Receipt ID Character length and limitations: 16 digits in xxxx-xxxx-xxxx-xxxx format	xs:string
	Transaction Type	The type of transaction cart: Transaction created by customer via the PayPal Shopping Cart feature. send-money: Transaction created by customer from the Send Money tab on the PayPal website. web-accept: Transaction created by customer via Buy Now, Donation, or Auction Smart Logos. subscr-*: Transaction created by customer via Subscription. eot means “end of subscription term.” merch-pmt: preapproved payment. virtual-terminal: Transaction created via merchant virtual terminal.	ebl:Payment TransactionCode Type xs:token cart send_money web-accept subscr-failed subscr-cancel subscr-payment subscr-signup subscr-eot subscr-modify mercht-pmt mass-pay virtual-terminal express-checkout
	PaymentType	Indicates whether the payment is instant or delayed. Character length and limitations: Seven single-byte characters	ebl:PaymentCode Type xs:string none echeck instant
	PaymentDate	Date and time of payment	xs:dateTime
	GrossAmount	Full amount of the customer’s payment, before transaction fee is subtracted	xs:string
	FeeAmount	Transaction fee associated with the payment	xs:string
	SettleAmount	Amount deposited into the account’s primary balance after a currency conversion from automatic conversion through your Payment Receiving Preferences or manual conversion through manually accepting a payment. This amount is calculated after fees and taxes have been assessed.	ebl:BasicAmount Type
	TaxAmount	Amount of tax for transaction	xs:string
	ExchangeRate	Exchange rate for transaction	xs:string
	PaymentStatus	Status of the payment. The status of the payment: l None: No status l Canceled-Reversal: This means a reversal has been canceled. For example, you won a dispute with the customer, and the funds for the transaction that was reversed have been returned to you. l Completed: The payment has been completed, and the funds have been added successfully to your account balance. l Denied: You denied the payment. This happens only if the payment was previously pending because of possible reasons described for the PendingReason element. l Expired: the authorization period for this payment has been reached. l Failed: The payment has failed. This happens only if the payment was made from your customer’s bank account. l Pending: The payment is pending. See the PendingReason field for more information. l Refunded: You refunded the payment. l 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. l Processed: A payment has been accepted. l Voided: An authorization for this transaction has been voided.	ebl:Payment Status CodeType xs:token None Canceled-Reversal Completed Denied Expired Failed In-Progress Partially- Refunded Pending Processed Refunded Reversed Voided
	PendingReason	Note: PendingReason is returned in the response only if PaymentStatus is Pending. The reason the payment is pending: l none: No pending reason l address: The payment is pending because your customer 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. l echeck: The payment is pending because it was made by an eCheck that has not yet cleared. l 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. l 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. l verify: The payment is pending because you are not yet verified. You must verify your account before you can accept this payment. l other: The payment is pending for a reason other than those listed above. For more information, contact PayPal Customer Service.	ebl:Pending Status CodeType xs:token none authorization address echeck intl multi-currency unilateral upgrade verify other
	ReasonCode	The reason for a reversal if TransactionType is reversal: l none: No reason code l chargeback: A reversal has occurred on this transaction due to a chargeback by your customer. l guarantee: A reversal has occurred on this transaction due to your customer triggering a money-back guarantee. l buyer-complaint: A reversal has occurred on this transaction due to a complaint about the transaction from your customer. l refund: A reversal has occurred on this transaction because you have given the customer a refund. l other: A reversal has occurred on this transaction due to a reason not listed above.	ebl:ReasonCode Type xs:token none chargeback guarantee buyer-complaint refund other
PaymentItem Info		Includes the following elements	ebl:PaymentItem InfoType
	InvoiceID	Invoice number you set in the original transaction. Character length and limitations: 127 single-byte alphanumeric characters	xs:string
	Custom	Custom field you set in the original transaction. Character length and limitations: 127 single-byte alphanumeric characters	xs:string
	Memo	Memo entered by your customer in PayPal Website Payments note field. Character length and limitations: 255 single-byte alphanumeric characters	xs:string
PaymentItem	SaleTax	Amount of tax charged on payment	xs:string
	Name	Item name set by you or entered by the customer. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_name variable. For example, item_name1, item_name2, and so forth. Character length and limitations: 127 single-byte alphanumeric characters	xs:string
	Number	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	xs:string
	Quantity	Quantity set by you or entered by the customer. Character length and limitations: no limit	xs:string
	Amount	Cost of item	ebl:BasicAmount Type
	Options	PayPal item options for shopping cart	ns:OptionType name: xs:string value: xs:string
Subscription		Includes the following elements	ebl:Subscription InfoType
	SubscriptionID	ID generated by PayPal for the subscriber. Character length and limitations: no limit	xs:string
	Subscription Date	Subscription start date	xs:dateTime
	EffectiveDate	Date when the subscription modification will be effective	xs:dateTime
	RetryTime	Date PayPal will retry a failed subscription payment.	xs:dateTime
	Username	Username generated by PayPal and given to subscriber to access the subscription. Character length and limitations: 64 alphanumeric single-byte characters	xs:string
	Password	Password generated by PayPal and given to subscriber to access the subscription. For security, the value of the password is hashed. Character length and limitations: 128 alphanumeric single-byte characters	xs:string
	Recurrences	The number of payment installments that will occur at the regular rate. Character length and limitations: no limit	xs:string
	reattempt	Indicates whether reattempts should occur upon payment failures	xs:string
	recurring	Indicates whether regular rate recurs. 1 = Yes	xs:string
Subscription TermsType	Amount	The amount subscriber is to be charged in one payment. Character length and limitations: no limit	eb:BasicAmount Type
	period	The period of time that the subscriber will be charged. Character length and limitations: no limit	xs:string
Auction		Includes the following elements	ebl:Auction InfoType
	BuyerID	Customer’s auction ID	xs:string
	ClosingDate	Auction’s close date	xs:string
	multiItem	Counter used for multi-item auction payments	xs:string