2009
Table Of Contents
- Name-Value Pair API Developer Guide
- Preface
- This Document
- Intended Audience
- Revision History
- PayPal NVP API Overview
- Authorization and Capture API Operation Reference
- DoDirectPayment API
- Express Checkout API Operations
- GetTransactionDetails API
- MassPay API
- RefundTransaction API
- TransactionSearch API
- Recurring Payments and Reference Transactions API Operations
- DoNonReferencedCredit API
- ManagePendingTransactionStatu s API
- GetBalance API
- AddressVerify API
- API Error Codes
- General API Errors
- Validation Errors
- Direct Payment API Errors
- SetExpressCheckout API Errors
- GetExpressCheckoutDetails API Errors
- DoExpressCheckoutPayment API Errors
- Authorization and Capture API Errors
- GetTransactionDetails API Errors
- TransactionSearch API Errors
- RefundTransaction API Errors
- Mass Pay API Errors
- Recurring Payments Errors
- SetCustomerBillingAgreement Errors
- GetBillingAgreementCustomerDetails Errors
- CreateBillingAgreement Errors
- UpdateBillingAgreement Errors
- DoReferenceTransaction Errors
- AddressVerify API Errors
- ManagePendingTransactionStatus API Errors
- Country Codes
- State and Province Codes
- Currency Codes
- AVS and CVV2 Response Codes
Name-Value Pair API Developer Guide 08 April 2009 93
TransactionSearch API
TransactionSearch Request
TRANSACTIONCLASS (Optional) Search by classification of transaction.
Some kinds of possible classes of transactions are not searchable with this field. You
cannot search for bank transfer withdrawals, for example.
z All: all transaction classifications
z Sent: only payments sent
z Received: only payments received
z MassPay: only mass payments
z MoneyRequest: only money requests
z FundsAdded: only funds added to balance
z FundsWithdrawn: only funds withdrawn from balance
z Referral: only transactions involving referrals
z Fee: only transactions involving fees
z Subscription: only transactions involving subscriptions
z Dividend: only transactions involving dividends
z Billpay: only transactions involving BillPay Transactions
z Refund: only transactions involving funds
z CurrencyConversions: only transactions involving currency conversions
z BalanceTransfer: only transactions involving balance transfers
z Reversal: only transactions involving BillPay reversals
z Shipping: only transactions involving UPS shipping fees
z BalanceAffecting: only transactions that affect the account balance
z ECheck: only transactions involving eCheck
AMT (Optional) 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.
CURRENCYCODE (Optional) Search by currency code.
STATUS (Optional) Search by transaction status:
z Pending: The payment is pending. The specific reason the payment is pending is
returned by the GetTransactionDetails API PendingReason field.
z Processing: The payment is being processed.
z Success: The payment has been completed and the funds have been added
successfully to your account balance.
z Denied: You denied the payment. This happens only if the payment was
previously pending.
z 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.
Field Description