TransactionSearch API

 

With TransactionSearchRequest you must always set the StartDate field. Some other behavior:

l	Setting TransactionIDoverrides all other fields (even the required StartDate field).

l	The effect of setting other elements is additive or can alter the search criteria.

TransactionSearchResponse returns up to 100 matches. Partial matches are displayed. For example, setting the TransactionSearchRequest FirstName to “Jess” returns results such as “Jessica” and “Jesse”.

The most important returned element is TransactionID, which you can pass to GetTransactionDetailsRequest in order to retrieve all available information about a specific transaction.

Diagram of TransactionSearch Types

The following diagram represents the composition of the TransactionSearchRequestType and PaymentTransactionSearchResultsType elements.

Figure 9.1

TransactionSearch Types

TransactionSearchRequest

Request to search transaction history.

Table 9.1

TransactionSearchRequest Fields

Field	Description	Required?
StartDate	xs:dateTime The earliest transaction date at which to start the search. No wildcards are allowed. The value must be in UTC/GMT format.	Yes
EndDate	xs:dateTime The latest transaction date to be included in the search	No
Payer	xs:string ebl:EmailAddressType Search by the buyer’s email address Character length and limitations: 127 single-byte alphanumeric characters	No
Receiver	ebl:EmailAddressType Search by the receiver’s email address. If the merchant account has only one email, this is the primary email. Can also be a non-primary email.	No
ReceiptID	xs:string Search by the PayPal Account Optional receipt ID	No
TransactionID	ebl:TransactionID Search by the transaction ID. The returned results are from the merchant’s transaction records. Character length and limitations: 19 single-byte characters maximum	No
InvoiceID	xs:string Search by invoice identification key, as set by you for the original transaction. This field searches the records for items sold by the merchant, not the items purchased. IMPORTANT: No wildcards are allowed. Character length and limitations: 127 single-byte characters maximum	No
CardNumber	xs:string Search by credit card number, as set by you for the original transaction. This field searches the records for items sold by the merchant, not the items purchased. IMPORTANT: No wildcards are allowed. Character length and limitations: Must be at least 11 and no more than 25 single-byte numeric characters maximum. Special punctuation, such as dashes or spaces, is ignored.	No
PayerName	ebl:PersonNameType Search by the buyer's name l Salutation: 20 single-byte character limit l FirstName: 25 single-byte character limit l MiddleName: 25 single-byte character limit l LastName: 25 single-byte character limit l Suffix: 12 single-byte character limit	No
AuctionItemNumber	xs:string Search by auction item number of the purchased goods	No
TransactionClass	ebl:PaymentTransactionClassCodeType Search by classification of transaction. Note: Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. l All: all transaction classifications l Sent: only payments sent l Received: only payments received l MoneyRequest: only money requests l FundsAdded: only funds added to balance l FundsWithdrawn: only funds withdrawn from balance l Referral: only transactions involving referrals l Fee: only transactions involving fees l Subscription: only transactions involving subscriptions l Dividend: only transactions involving dividends l CurrencyConversions: only transactions involving currency conversions l BalanceTransfer: only transactions involving balance transfers l Shipping: only transactions involving UPS shipping fees l BalanceAffecting: only transactions that affect the account balance l ECheck: only transactions involving eCheck	No
Amount	ebl:BasicAmountType Search by transaction amount Note: You must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies.	No
CurrencyCode	xs:token Search by currency code	No
Status	ebl:PaymentTransactionStatusCodeType Search by transaction status: l Pending: The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field. l Processing: The payment is being processed. l Success: 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. 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.	No

TransactionSearchResponse

Response to TransactionSearchRequest.

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

Table 9.2

PaymentTransactions Fields

Field	Description
Timestamp	xs:dateTime The date and time (in UTC/GMT format) the transaction occurred
Timezone	xs:string The time zone of the transaction
Type	xs:string The type of the transaction
Payer	ebl:EmailAddressType The email address of either the payer or the payment recipient (the “payee”). If the payment amount is positive, this field is the recipient of the funds. If the payment is negative, this field is the paying customer.
PayerDisplayName	xs:string Display name of the payer
TransactionID	xs:string Seller’s transaction ID
Status	xs:string The status of the transaction.
GrossAmount	ebl:BaicAmount Type The total gross amount charged, including any profile shipping cost and taxes
FeeAmount	ebl:BasicAmountType The fee that PayPal charged for the transaction
NetAmount	ebl:BasicAmountType The net amount of the transaction