This refers to the version of the request payload schema.

The earliest transaction date at which to start the search. No wildcards are allowed.

Required

The latest transaction date to be included in the search

Optional

Search by the buyer's email address

Optional

Character length and limitations: 127 single-byte alphanumeric characters

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.

Optional

Search by the PayPal Account Optional receipt ID

Optional

Search by the transaction ID.

Optional

The returned results are from the merchant's transaction records.

Character length and limitations: 19 single-byte characters maximum

Search by Recurring Payment Profile id. The ProfileID is returned as part of the CreateRecurringPaymentsProfile API response.

Optional

Search by item number of the purchased goods.

Optional

To search for purchased items not related to auctions, set the AuctionItemNumber element to the value of the HTML item_number variable set in the shopping cart for the original transaction.

Search by invoice identification key, as set by you for the original transaction. InvoiceID searches the invoice records for items sold by the merchant, not the items purchased.

Optional

The value for InvoiceID must exactly match an invoice identification number. No wildcards are allowed.

Character length and limitations: 127 single-byte characters maximum

Search by classification of transaction. Some kinds of possible classes of transactions are not searchable with TransactionSearchRequest. You cannot search for bank transfer withdrawals, for example.

Optional

All: all transaction classifications.

Sent: only payments sent.

Received: only payments received.

MassPay: only mass payments.

MoneyRequest: only money requests.

FundsAdded: only funds added to balance.

FundsWithdrawn: only funds withdrawn from balance.

Referral: only transactions involving referrals.

Fee: only transactions involving fees.

Subscription: only transactions involving subscriptions.

Dividend: only transactions involving dividends.

Billpay: only transactions involving BillPay Transactions.

Refund: only transactions involving funds.

CurrencyConversions: only transactions involving currency conversions.

BalanceTransfer: only transactions involving balance transfers.

Reversal: only transactions involving BillPay reversals.

Shipping: only transactions involving UPS shipping fees.

BalanceAffecting: only transactions that affect the account balance.

ECheck: only transactions involving eCheck

ForcedPostTransaction: forced post transaction.

NonReferencedRefunds: non-referenced refunds.

Search by transaction amount

Optional

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

Search by currency code

Optional

Search by transaction status

Optional

Pending: The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails APIPendingReason element. For more information, see PendingReason.

Processing: The payment is being processed.

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

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.