TransactionSearch API Operation (SOAP)

Searches transaction history for transactions that meet the specified criteria.

Note: The maximum number of transactions that can be returned from a TransactionSearch API call is 100.

TransactionSearch Request Message

Note: Only the fields described in this documentation are available for use.

TransactionSearch Request Fields

Field Description

StartDate

xs:dateTime

(Required) The earliest transaction date at which to start the search.

Character length and limitations:

Must be a valid date, in UTC/GMT format; for example, 2013-08-24T05:38:48Z. No wildcards are allowed.

EndDate

xs:dateTime

(Optional) The latest transaction date to be included in the search.

Character length and limitations:

Must be a valid date, in UTC/GMT format; for example, 2013-08-24T05:38:48Z. No wildcards are allowed.

Payer

ebl:EmailAddressType

(Optional) Search by the buyer's email address.

Character length and limitations: 127 single-byte alphanumeric characters

Receiver

ebl:EmailAddressType

(Optional) Search by the receiver's email address. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address.

ReceiptID

xs:string

(Optional) Search by the PayPal Account Optional receipt ID. This field is not applicable to point-of-sale transactions.

TransactionID

ebl:TransactionID

(Optional) Search by the transaction ID. The returned results are from the merchant's transaction records.

Character length and limitations: 17 characters except for transactions of the type Order have a character length of 19.

InvoiceID

xs:string

(Optional) Search by invoice identification key, as set by you for the original transaction. This field searches the records for items the merchant sells.

Character length and limitations: 127 single-byte characters maximum with no wildcards allowed

CardNumber

xs:string

(Optional) Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells. The field is not applicable to point-of-sale.

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

PayerName

ebl:PersonNameType

(Optional) Search by the buyer's name.

AuctionItemNumber

xs:string

(Optional) Search by auction item number of the purchased goods. This field is not applicable to point-of-sale.

TransactionClass

ePaymentTransactionClassCodeType

(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. Value is:

  • 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

Amount

ebl:BasicAmountType

(Optional) Search by transaction amount.

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

Character length and limitations:

Value is typically a positive number that cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. Most currencies require two decimal places. The decimal separator must be a period (.), and the optional thousands separator must be a comma (,). Some currencies do not allow decimals. For details, see the currency codes page.

CurrencyCode

xs:token

(Optional) Search by 3-character, ISO 4217 currency code.

Status

ebl:PaymentTransactionStatusCodeType

(Optional) Search by transaction status. Value is:

  • Pending — The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field.

  • 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.

ProfileID

xs:string

(Optional) An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile ID in the TransactionSearch API operation to obtain all payments associated with the identified profile.

PayerName Fields

Field Description

Salutation

xs:string

(Optional) Buyer's salutation.

Character length and limitations: 20 single-byte characters

FirstName

ebl:PersonNameType

(Optional) Buyer's first name.

Character length and limitations: 64 double-byte characters

MiddleName

ebl:NameUser

(Optional) Buyer's middle name.

Character length and limitations: 64 double-byte characters

LastName

ebl:NameType

(Optional) Buyer's last name.

Character length and limitations: 64 double-byte characters

Suffix

ebl:SuffixType

(Optional) Buyer's suffix.

Character length and limitations: 12 single-byte characters

TransactionSearch Response Message

Note: Only the fields described in this documentation are available for use.

Note: Only the fields described in this documentation are available for use.

TransactionSearch Response Fields

Field Description

Timestamp

xs:dateTime

Date and time that the transaction occurred.

Character length and limitations:

Date and time are in UTC/GMT format. For example, 2013-08-24T05:38:48Z.

Timezone

xs:string

Time zone of the transaction. The value is always GMT.

Type

xs:string

Type of the transaction. Value is:

  • Currency Conversion (credit)

  • Currency Conversion (debit)

  • Payment

  • Recurring Payment

  • Temporary Hold

  • Transfer

  • Donation

Payer

ebl:EmailAddressType

Email address of either the buyer 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 buyer.

PayerDisplayName

xs:string

Display name of the buyer.

TransactionID

xs:string

Merchant's transaction ID.

Status

xs:string

The status of the transaction. Value is:

  • Pending — The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field.

  • 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.

GrossAmount

ebl:BasicAmountType

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.

Additional information