PayPal Connector Objects (SOAP Schema)

NameDescription
BalanceView all the currencies of the account and their balances.
BalanceAffectingQuery Transactions that affect the account balance.
BalanceTransferQuery Transactions involving Balance Transfers.
BillPayQuery Transactions involving BillPay Transactions.
CurrencyConversionsQuery Transactions involving Currency Conversions.
DividendQuery Transactions involving Dividends.
ECheckQuery Transactions involving eChecks.
FeeQuery Transactions involving Fees.
FundsAddedQuery Transactions generated when funds are added to the balance.
FundsWithdrawnQuery Transactions generated when funds are withdrawn from the balance.
MassPayQuery Mass Payments Transactions.
MoneyRequestQuery Money Request Transactions.
ReceivedQuery payments-received Transactions.
ReferralQuery Transactions involving Referrals.
RefundQuery Transactions involving Refunds.
ReversalQuery Transactions involving BillPay Reversals.
SentQuery payments-sent Transactions.
ShippingQuery Transactions involving UPS Shipping Fees.
SubscriptionQuery Transactions involving Subscriptions.
TransactionDetailsQuery details about a specific Transaction using the GetTransactionDetails API.
TransactionItemsQuery details about a specific Transaction's items using the GetTransactionDetails API.
TransactionsQuery Transaction history using the TransactionSearch API.
NameTypeReadOnlyReferencesFilterOnlyDescription
CurrencyIDStringFalseNoThe currency of the balance.
BalanceDoubleFalseNoThe balance of the associated currency.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoDate and time that the transaction occurred. Character length and limitations: The date and time of the transaction.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe 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.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch by the credit card number, as set by you for the original transaction. The field is not applicable to point-of-sale.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesAn 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesAn 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. This field is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoThe date and time that the transaction occurred.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe type of the transaction. It is one of the following values: Currency Conversion (credit), Currency Conversion (debit), Payment, Recurring Payment, Temporary Hold, Transfer, Donation.
PayerStringFalseNoThe email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesSearch 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TransactionId [KEY]StringFalseNoUnique transaction Id of the payment.
ReceiverBusinessStringFalseNoDetails about a single transaction. This field is not applicable for point-of-sale transactions.
ReceiverEmailStringFalseNoPrimary email address of the payment recipient (the merchant).
ReceiverIdStringFalseNoUnique account Id of the payment recipient (the merchant). This value is the same as the value of the referral Id of the recipient.
PayerEmailStringFalseNoEmail address of the buyer.
PayerIdStringFalseNoUnique PayPal Customer Account identification number.
PayerStatusStringFalseNoStatus of the buyer.
PayerFirstNameStringFalseNoThe first name of the buyer.
PayerMiddleNameStringFalseNoThe middle name of the buyer.
PayerLastNameStringFalseNoThe last name of the buyer.
PayerSuffixStringFalseNoThe suffix of the buyer.
PayerCountryStringFalseNoThe country of residence of the buyer in the form of ISO standard 3166 2-character country codes.
PayerBusinessStringFalseNoThe business name of the buyer.
StreetAddressStringFalseNoThe first street address.
CityStringFalseNoThe name of the city.
StateStringFalseNoThe state or province.
PostalCodeStringFalseNoU.S. ZIP code or other country-specific postal code.
ShippingCountryStringFalseNoThe expanded name of the country.
PayerPhoneStringFalseNoThe phone number.
ParentTransactionIdStringFalseNoThe parent or related transaction identification number.
TransactionTypeStringFalseNoThe type of transaction.
PaymentTypeStringFalseNoIndicates whether the payment is instant or delayed.
PaymentDateDatetimeFalseNoThe date-time stamp of the payment.
GrossAmountDecimalFalseNoThe final amount charged, including any shipping and taxes from your Merchant Profile.
FeeAmountDecimalFalseNoThe PayPal fee amount charged for the transaction.
SettleAmountDecimalFalseNoThe amount deposited in your PayPal account after a currency conversion.
TaxAmountDecimalFalseNoThe tax charged on the transaction.
ExchangeRateStringFalseNoThe 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.
PaymentStatusStringFalseNoStatus of the payment.
PendingReasonStringFalseNoThe reason the payment is pending.
ProtectionEligibilityStringFalseNoPrior to version 64.4, the kind of seller protection in force for the transaction.
ProtectionEligibilityTypeStringFalseNoSince version 64.4, the kind of seller protection in force for the transaction.
StoreIdStringFalseNoStoreId as entered in the transaction.
SubjectStringFalseNoThe value of the subject field entered by the buyer when making a payment.
InvoiceIdStringFalseNoInvoice number you set in the original transaction.
MemoStringFalseNoMemo entered by your customer in the PayPal Website Payments note field.
SalesTaxDecimalFalseNoAmount of tax charged on payment.
AuctionBuyerIdStringFalseNoThe auction Id of the buyer.
AuctionClosingDateDatetimeFalseNoThe close date of the auction.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
TransactionIDStringFalseNoUnique transaction Id of the payment.
EbayItemTxnIdStringFalseNoThe eBay auction transaction Id of the item that you use to identify items that the buyer purchased.
ItemNameStringFalseNoItem name set by you or entered by the customer.
ItemNumberIntegerFalseNoItem 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.
ShippingAmountDecimalFalseNoShipping Amount.
HandlingAmountDecimalFalseNoHandling Amount.
QuantityIntegerFalseNoQuantity set by you or entered by the buyer.
CouponIdStringFalseNoCoupon identification number.
CouponAmountDecimalFalseNoAmount (value) of the coupon.
ItemAmountDecimalFalseNoCost of the item.
CouponAmountCurrencyStringFalseNoCurrency of the coupon amount, e.g., a 3-character currency code.
SalesTaxDecimalFalseNoAmount of tax charged on payment for this item.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe Id of the transaction record of the merchant.
PayerDisplayNameStringFalseNoThe display name of the buyer.
NetAmountDecimalFalseNoThe net amount of the transaction.
FeeAmountDecimalFalseNoThe fee that PayPal charged for the transaction.
GrossAmountDecimalFalseNoThe total gross amount charged, including any profile shipping cost and taxes.
StatusStringFalseNoThe status of the transaction. It is one of the following values: Pending, Processing, Success, Denied, or Reversed.
DateDatetimeFalseNoDate 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.
TimezoneStringFalseNoThe time zone of the transaction. The value is always GMT.
TypeStringFalseNoThe 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.
PayerStringFalseNoSearch by the email address of the buyer. Character length and limitations: 127 single-byte alphanumeric characters.
TransactionClassStringFalseYesSearch 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.
AmountStringFalseYesSearch 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.
AuctionItemNumberStringFalseYesSearch by the auction item number of the purchased goods. This field is not applicable to point-of-sale.
CardNumberStringFalseYesSearch 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.
CurrencyCodeStringFalseYesSearch by the 3-character, ISO 4217 currency code.
InvoiceIdStringFalseYesSearch 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.
ProfileIdStringFalseYesAn 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.
ReceiptIdStringFalseYesSearch by the PayPal Account Optional receipt Id. This field is not applicable to point-of-sale transactions.
ReceiverStringFalseYesSearch 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.
PayerNameStringFalseYesSearch by the name of the buyer.

Return to Top