PayPal Connector Objects (SOAP Schema)
Name | Description |
---|---|
Balance | View all the currencies of the account and their balances. |
BalanceAffecting | Query Transactions that affect the account balance. |
BalanceTransfer | Query Transactions involving Balance Transfers. |
BillPay | Query Transactions involving BillPay Transactions. |
CurrencyConversions | Query Transactions involving Currency Conversions. |
Dividend | Query Transactions involving Dividends. |
ECheck | Query Transactions involving eChecks. |
Fee | Query Transactions involving Fees. |
FundsAdded | Query Transactions generated when funds are added to the balance. |
FundsWithdrawn | Query Transactions generated when funds are withdrawn from the balance. |
MassPay | Query Mass Payments Transactions. |
MoneyRequest | Query Money Request Transactions. |
Received | Query payments-received Transactions. |
Referral | Query Transactions involving Referrals. |
Refund | Query Transactions involving Refunds. |
Reversal | Query Transactions involving BillPay Reversals. |
Sent | Query payments-sent Transactions. |
Shipping | Query Transactions involving UPS Shipping Fees. |
Subscription | Query Transactions involving Subscriptions. |
TransactionDetails | Query details about a specific Transaction using the GetTransactionDetails API. |
TransactionItems | Query details about a specific Transaction's items using the GetTransactionDetails API. |
Transactions | Query Transaction history using the TransactionSearch API. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
CurrencyID | String | False | No | The currency of the balance. | |
Balance | Double | False | No | The balance of the associated currency. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | Date and time that the transaction occurred. Character length and limitations: The date and time of the transaction. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 nonprimary email address. | |
PayerName | String | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, or Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | Search by the transaction amount. You must set the CurrencyCode field 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | False | Yes | Search by 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 nonprimary email address. | |
PayerName | String | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale. | |
CurrencyCode | String | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | Search by the invoice identification key, as set by you for the original transaction. Character length and limitations: 127 single-byte characters maximum with no wildcards allowed. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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 | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | The date and time that the transaction occurred. | |
Timezone | String | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | The type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation. | |
Payer | String | False | No | The email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | Search by the 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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. | |
ProfileId | String | False | Yes | Search by the 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TransactionId [KEY] | String | False | No | Unique transaction Id of the payment. | |
ReceiverBusiness | String | False | No | Details about a single transaction. This field is not applicable for point-of-sale transactions. | |
ReceiverEmail | String | False | No | Primary email address of the payment recipient (the merchant). | |
ReceiverId | String | False | No | Unique account Id of the payment recipient (the merchant). This value is the same as the value of the referral Id of the recipient. | |
PayerEmail | String | False | No | Email address of the buyer. | |
PayerId | String | False | No | Unique PayPal Customer Account identification number. | |
PayerStatus | String | False | No | Status of the buyer. | |
PayerFirstName | String | False | No | The first name of the buyer. | |
PayerMiddleName | String | False | No | The middle name of the buyer. | |
PayerLastName | String | False | No | The last name of the buyer. | |
PayerSuffix | String | False | No | The suffix of the buyer. | |
PayerCountry | String | False | No | The country of residence of the buyer in the form of ISO standard 3166 2-character country codes. | |
PayerBusiness | String | False | No | The business name of the buyer. | |
StreetAddress | String | False | No | The first street address. | |
City | String | False | No | The name of the city. | |
State | String | False | No | The state or province. | |
PostalCode | String | False | No | U.S. ZIP code or other country-specific postal code. | |
ShippingCountry | String | False | No | The expanded name of the country. | |
PayerPhone | String | False | No | The phone number. | |
ParentTransactionId | String | False | No | The parent or related transaction identification number. | |
TransactionType | String | False | No | The type of transaction. | |
PaymentType | String | False | No | Indicates whether the payment is instant or delayed. | |
PaymentDate | Datetime | False | No | The date-time stamp of the payment. | |
GrossAmount | Decimal | False | No | The final amount charged, including any shipping and taxes from your Merchant Profile. | |
FeeAmount | Decimal | False | No | The PayPal fee amount charged for the transaction. | |
SettleAmount | Decimal | False | No | The amount deposited in your PayPal account after a currency conversion. | |
TaxAmount | Decimal | False | No | The tax charged on the transaction. | |
ExchangeRate | String | False | No | The exchange rate if a currency conversion occurred. This is relevant only if you are billing in the non-primary currency of the buyer. If the buyer chooses to pay with a currency other than the non-primary currency, the conversion occurs in the account of the buyer. | |
PaymentStatus | String | False | No | Status of the payment. | |
PendingReason | String | False | No | The reason the payment is pending. | |
ProtectionEligibility | String | False | No | Prior to version 64.4, the kind of seller protection in force for the transaction. | |
ProtectionEligibilityType | String | False | No | Since version 64.4, the kind of seller protection in force for the transaction. | |
StoreId | String | False | No | StoreId as entered in the transaction. | |
Subject | String | False | No | The value of the subject field entered by the buyer when making a payment. | |
InvoiceId | String | False | No | Invoice number you set in the original transaction. | |
Memo | String | False | No | Memo entered by your customer in the PayPal Website Payments note field. | |
SalesTax | Decimal | False | No | Amount of tax charged on payment. | |
AuctionBuyerId | String | False | No | The auction Id of the buyer. | |
AuctionClosingDate | Datetime | False | No | The close date of the auction. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
TransactionID | String | False | No | Unique transaction Id of the payment. | |
EbayItemTxnId | String | False | No | The eBay auction transaction Id of the item that you use to identify items that the buyer purchased. | |
ItemName | String | False | No | Item name set by you or entered by the customer. | |
ItemNumber | Integer | False | No | Item number set by you. If this was a shopping cart transaction, PayPal appends the number of the item to the HTML item_number variable, for example, item_number1, item_number2, and so forth. | |
ShippingAmount | Decimal | False | No | Shipping Amount. | |
HandlingAmount | Decimal | False | No | Handling Amount. | |
Quantity | Integer | False | No | Quantity set by you or entered by the buyer. | |
CouponId | String | False | No | Coupon identification number. | |
CouponAmount | Decimal | False | No | Amount (value) of the coupon. | |
ItemAmount | Decimal | False | No | Cost of the item. | |
CouponAmountCurrency | String | False | No | Currency of the coupon amount, e.g., a 3-character currency code. | |
SalesTax | Decimal | False | No | Amount of tax charged on payment for this item. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The Id of the transaction record of the merchant. | |
PayerDisplayName | String | False | No | The display name of the buyer. | |
NetAmount | Decimal | False | No | The net amount of the transaction. | |
FeeAmount | Decimal | False | No | The fee that PayPal charged for the transaction. | |
GrossAmount | Decimal | False | No | The total gross amount charged, including any profile shipping cost and taxes. | |
Status | String | False | No | The status of the transaction. It is one of the following values: Pending, Processing, Success, Denied, or Reversed. | |
Date | Datetime | False | No | 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 | False | No | The time zone of the transaction. The value is always GMT. | |
Type | String | False | No | 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 | False | No | Search by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters. | |
TransactionClass | String | False | Yes | 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. | |
Amount | String | False | Yes | 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 | False | Yes | Search by the auction item number of the purchased goods. This field is not applicable to point-of-sale. | |
CardNumber | String | False | Yes | 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 | False | Yes | Search by the 3-character, ISO 4217 currency code. | |
InvoiceId | String | False | Yes | 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 | False | Yes | 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 | False | Yes | Search by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions. | |
Receiver | String | False | Yes | 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 | False | Yes | Search by the name of the buyer. |