Class: PayPal::SDK::Merchant::DataTypes::TransactionSearchRequestType

Inherits:

AbstractRequestType

• Object
• Core::API::DataTypes::Base
• DataType
• AbstractRequestType
• PayPal::SDK::Merchant::DataTypes::TransactionSearchRequestType

Defined in:

lib/paypal-sdk/merchant/data_types.rb

Overview

The earliest transaction date at which to start the search. No wildcards are allowed. Required

Class Method Summary

• .load_members ⇒ Object

Class Method Details

.load_members ⇒ Object

# File 'lib/paypal-sdk/merchant/data_types.rb', line 3974

def self.load_members
  # The earliest transaction date at which to start the search. No wildcards are allowed. Required
  object_of :StartDate, DateTime, :namespace => :ns, :required => true
  # The latest transaction date to be included in the search Optional
  object_of :EndDate, DateTime, :namespace => :ns
  # Search by the buyer's email address OptionalCharacter length and limitations: 127 single-byte alphanumeric characters
  object_of :Payer, String, :namespace => :ns
  # Search by the receiver's email address. If the merchant account has only one email, this is the primary email. Can also be a non-primary email.Optional
  object_of :Receiver, String, :namespace => :ns
  # Search by the PayPal Account Optional receipt IDOptional
  object_of :ReceiptID, String, :namespace => :ns
  # Search by the transaction ID. OptionalThe returned results are from the merchant's transaction records. Character length and limitations: 19 single-byte characters maximum
  object_of :TransactionID, String, :namespace => :ns
  # Search by Recurring Payment Profile id. The ProfileID is returned as part of the CreateRecurringPaymentsProfile API response. Optional
  object_of :ProfileID, String, :namespace => :ns
  # Search by the buyer's name OptionalSalutation: 20 single-byte character limit.FirstName: 25 single-byte character limit.MiddleName: 25 single-byte character limit.LastName: 25 single-byte character limit.Suffix: 12 single-byte character limit.
  object_of :PayerName, PersonNameType, :namespace => :ns
  # Search by item number of the purchased goods.OptionalTo search for purchased items not related to auctions, set the AuctionItemNumber element to the value of the HTML item_number variable set in the shopping cart for the original transaction.
  object_of :AuctionItemNumber, String, :namespace => :ns
  # Search by invoice identification key, as set by you for the original transaction. InvoiceID searches the invoice records for items sold by the merchant, not the items purchased. OptionalThe value for InvoiceID must exactly match an invoice identification number. No wildcards are allowed. Character length and limitations: 127 single-byte characters maximum
  object_of :InvoiceID, String, :namespace => :ns
  object_of :CardNumber, String, :namespace => :ns
  # Search by classification of transaction. Some kinds of possible classes of transactions are not searchable with TransactionSearchRequest. You cannot search for bank transfer withdrawals, for example. OptionalAll: all transaction classifications.Sent: only payments sent.Received: only payments received.MassPay: only mass payments.MoneyRequest: only money requests.FundsAdded: only funds added to balance.FundsWithdrawn: only funds withdrawn from balance.Referral: only transactions involving referrals.Fee: only transactions involving fees.Subscription: only transactions involving subscriptions.Dividend: only transactions involving dividends.Billpay: only transactions involving BillPay Transactions.Refund: only transactions involving funds.CurrencyConversions: only transactions involving currency conversions.BalanceTransfer: only transactions involving balance transfers.Reversal: only transactions involving BillPay reversals.Shipping: only transactions involving UPS shipping fees.BalanceAffecting: only transactions that affect the account balance.ECheck: only transactions involving eCheckForcedPostTransaction: forced post transaction.NonReferencedRefunds: non-referenced refunds.
  object_of :TransactionClass, PaymentTransactionClassCodeType, :namespace => :ns
  # Search by transaction amount OptionalYou must set the currencyID attribute to one of the three-character currency codes for any of the supported PayPal currencies. 
  object_of :Amount, BasicAmountType, :namespace => :ns
  # Search by currency codeOptional
  object_of :CurrencyCode, CurrencyCodeType, :namespace => :ns
  # Search by transaction status OptionalPending: The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails APIPendingReason element. For more information, see PendingReason.Processing: The payment is being processed.Success: The payment has been completed and the funds have been added successfully to your account balance.Denied: You denied the payment. This happens only if the payment was previously pending.Reversed: A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer.
  object_of :Status, PaymentTransactionStatusCodeType, :namespace => :ns
end