SearchCriteria Type

This type describes the criteria for the current search.

Remarks

Use this type to specify what search parameters should be sent to PayPal in the next Search.

Fields

Search by transaction amount.

Search by the Credit Card number used to make the transaction.

CardNumber must be at least 11 and no more than 25 characters in length. No wildcards are allowed. A card number search searches records for items sold by the merchant, and not the items the merchant has himself purchased.

CurrencyCode
String

Search by currency code.

EndDate
String

The latest transaction date to be included in the search.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

InvoiceId
String

Search by the invoice identification key.

This property may contain the Invoice Id, as set by the merchant for the original transaction. The Invoice Id search is performed on the invoice records for items sold by the merchant. It is not performed on items purchased.

ItemNumber
String

Search by the item number of the purchased goods.

To search for purchased items not related to auctions, set the ItemNumber property to the value of the HTML "item_number" variable that was set in the shopping cart for the original transaction.

PayerEmail
String

Search by the Payer's email address.

PayerFirstName
String

Search by the Payer's first name.

PayerLastName
String

Search by the Payer's last name.

PayerMiddleName
String

Search by the Payer's middle name.

PayerSalutation
String

Search by the Payer's salutation (Mr, Mrs, etc)

PayerSuffix
String

Search by the Payer's suffix (Jr, Sr, etc)

ReceiptId
String

Search by the PayPal Account optional Receipt Id.

RecipientEmail
String

Search by the receiver's email address.

StartDate
String

The earliest transaction date at which to start the search.

This property is a required parameter for any search, and must be set. Otherwise PayPal will reject the transaction and the component will fail with an error.

PayPal defines date/time values as Coordinated Universal Time (UTC/GMT), using ISO 8601 format. An example date/time stamp is 2006-08-24T05:38:48Z.

Status
int

Search by status.

Valid payment statuses are listed below:


sNone (0)	No status.
sPending (1)	The payment is pending. See PendingReason for more information.
sProcessing (2)	A Payment is currently being processed
sSuccess (3)	The payment has been completed and the funds have been added successfully to your account balance.
sDenied (4)	You, the merchant, denied the payment. This will only happen if the payment was previously pending due to one of these PendingReasons.
sReversed (5)	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.

TransactionClass
int

Search by the classification of the transaction.

Valid classes are listed below:


tcAll (0)	All transaction classifications (default).
tcSent (1)	Only payments sent.
tcReceived (2)	Only payments received.
tcMassPay (3)	Only mass payments.
tcMoneyRequest (4)	Only money requests.
tcFundsAdded (5)	Only funds added to balance.
tcFundsWithdrawn (6)	Only funds withdrawn from balance.
tcPayPalDebitCard (7)	Only transactions involving a PayPal debit card.
tcPrimaryDebitCard (8)	Only transactions involving a primary debit card.
tcSecondaryDebitCard (9)	Only transactions involving a secondary debit card.
tcReferral (10)	Only transactions involving referrals.
tcFee (11)	Only transactions involving fees.
tcSubscription (12)	Only transactions involving subscriptions.
tcDividend (13)	Only transactions involving dividends.
tcBillpay (14)	Only transactions involving BillPay Transactions.
tcRefund (15)	Only transactions involving refunds.
tcCurrencyConversions (16)	Only transactions involving currency conversions.
tcBalanceTransfer (17)	Only transactions involving balance transfers.
tcReversal (18)	Only transactions involving BillPay reversals.
tcShipping (19)	Only transactions involving UPS shipping fees.
tcBalanceAffecting (20)	Only transactions that affect the account balance.
tcECheck (21)	Only transactions involving eCheck.

TransactionId
String

Search by the Transaction Id.

You may specify the transaction Id from either the buyer or the seller. However, the results are always returned from the seller's perspective.

Constructors

public SearchCriteria();

public SearchCriteria(String startDate);