Study Guide

PayPal Certified Developer Program Study Guide March 2008 95
Transactions
Transaction Searches
8
Transaction Searches
To find all transactions that occurred on a particular date, use the TransactionSearch API.
The date must be in UTC/GMT format.
With TransactionSearch, always set the StartDate field. Also note the following:
z Setting TransactionID overrides all other fields (including StartDate).
z The effect of setting other elements is additive or can alter the search criteria.
TransactionSearch returns up to 100 matches. Partial matches are displayed. For example,
setting the FirstName parameter of the TransactionSearch request to “Jess” returns
results including “Jessica” and “Jesse.”
The most important element returned in the TransactionSearch response is
TransactionID, which can be passed to GetTransactionDetails to retrieve all
available information about a specific transaction. For more information on the
GetTransactionDetails API, see “Retrieving Transaction Details” on page 98.
TransactionSearch Request
Use a TransactionSearch request to search for transactions that occurred on a given date.
TABLE 8.9 TransactionSearch Request Parameters
Parameter Description Required?
METHOD Name of API call: TransactionSearch Yes
STARTDATE The earliest transaction date at which to start the search.
No wildcards are allowed. The value must be in UTC/GMT format.
Yes
ENDDATE The latest transaction date to be included in the search. No
EMAIL Search by the customer’s email address.
Character length and limitations: 127 single-byte alphanumeric
characters.
No
RECEIVER Search by the receiver’s email address. If the merchant account has
only one email, this is the primary email. This also can be a
nonprimary email.
No
RECEIPTID Search by the PayPal Account Optional receipt ID. No
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