Transactions
Query Transaction history using the TransactionSearch API.
Table Specific Information
Select
The following filters are supported by the PayPal API:
- Id
- Date
- Receiver
- ReceiptId
- AuctionItemNumber
- TransactionClass
The Date filter supports the >, >=, <, <=, and = operators while the other filters only support the = operator.
The cmdlet processes other filters client side within the cmdlet.
For example, the following query is processed server side and retrieves Transactions that were created after the specified Date.
SELECT * FROM Transactions WHERE Date > '2015-12-15T12:00:00' AND Amount = '11'
Other important filter you can execute client-side is the Type filter. You can use that column to retrive i.e: only the Orders.
After retrieving the IDs of transactions with type order, you can use these IDs to query TransactionItems and TransactionDetails views, to get more details.
SELECT * FROM Transactions WHERE Type = 'Order'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The Id of the transaction record of the merchant. | |
| PayerDisplayName | String | The display name of the buyer. | |
| NetAmount | Decimal | The net amount of the transaction. | |
| FeeAmount | Decimal | The fee that PayPal charged for the transaction. | |
| GrossAmount | Decimal | The total gross amount charged, including any profile shipping cost and taxes. | |
| Status | String | The status of the transaction. It is one of the following values: Pending, Processing, Success, Denied, or Reversed.
The allowed values are Pending, Processing, Success, Denied, Reversed. | |
| Date | 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 | String | The time zone of the transaction. The value is always GMT. | |
| Type | String | The type of the transaction. It is one of the following values: Order, Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
| Payer | String | Search by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
| Name | Type | Description | |
| TransactionClass | String | Search by the classification of the transaction. Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. This field has one of the following values: All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, or ECheck.
The allowed values are All, Sent, Received, MassPay, MoneyRequest, FundsAdded, FundsWithdrawn, Referral, Fee, Subscription, Dividend, Billpay, Refund, CurrencyConversions, BalanceTransfer, Reversal, Shipping, BalanceAffecting, ECheck. | |
| Amount | String | Search by the transaction amount. You must set the CurrencyCode input to one of the 3-character currency codes for any of the supported PayPal currencies. This value cannot exceed 10,000.00 USD or the per transaction limit for the currency. It includes no currency symbol. | |
| AuctionItemNumber | String | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
| CardNumber | String | 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. | |
| CurrencyCode | String | Search by the 3-character, ISO 4217 currency code. | |
| InvoiceId | String | Search by the 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. | |
| ProfileId | String | An alphanumeric string (generated by PayPal) that uniquely identifies a recurring profile. You can specify the Profile Id to obtain all payments associated with the identified profile. | |
| ReceiptId | String | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
| Receiver | String | Search by the email address of the receiver. If the merchant account has only one email address, this is the primary email. It can also be a non-primary email address. | |
| PayerName | String | Search by the name of the buyer. |