Method: ActiveMerchant::Billing::PaypalCommonAPI#transaction_search

Defined in:
lib/active_merchant/billing/gateways/paypal/paypal_common_api.rb

#transaction_search(options) ⇒ Object

For full documentation see PayPal API Reference

Options:

  • :payer – (Optional) Search by the buyer’s email address.

  • :receipt_id – (Optional) Search by the PayPal Account Optional receipt ID.

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

  • :transaction_id – (Optional) Search by the transaction ID. The returned results are from the merchant’s transaction records.

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

  • :card_number – (Optional) Search by credit card number, as set by you for the original transaction. This field searches the records for items the merchant sells, not the items purchased.

  • :auction_item_number – (Optional) Search by auction item number of the purchased goods.

  • :transaction_class – (Optional) Search by classification of transaction. Some kinds of possible classes of transactions are not searchable with this field. You cannot search for bank transfer withdrawals, for example. It is one of the following values:

    All – All transaction classifications
Sent – Only payments sent
Received – Only payments received
MassPay – Only mass payments
MoneyRequest – Only money requests
FundsAdded – Only funds added to balance
FundsWithdrawn – Only funds withdrawn from balance
Referral – Only transactions involving referrals
Fee – Only transactions involving fees
Subscription – Only transactions involving subscriptions
Dividend – Only transactions involving dividends
Billpay – Only transactions involving BillPay Transactions
Refund – Only transactions involving funds
CurrencyConversions – Only transactions involving currency conversions
BalanceTransfer – Only transactions involving balance transfers
Reversal – Only transactions involving BillPay reversals
Shipping – Only transactions involving UPS shipping fees
BalanceAffecting – Only transactions that affect the  balance
ECheck – Only transactions involving eCheck

  • :currency_code – (Optional) Search by currency code.

  • :status – (Optional) Search by transaction status. It is one of the following values:

    One of:
Pending – The payment is pending. The specific reason the payment is pending is returned by the GetTransactionDetails API PendingReason field.
Processing – The payment is being processed.
Success – The payment has been completed and the funds have been added successfully to your account balance.
Denied – You denied the payment. This happens only if the payment was previously pending.
Reversed – A payment was reversed due to a chargeback or other type of reversal. The funds have been removed from your account balance and returned to the buyer.
[View source] [View on GitHub]

235
236
237
238
 
# File 'lib/active_merchant/billing/gateways/paypal/paypal_common_api.rb', line 235

def transaction_search(options)
  requires!(options, :start_date)
  commit 'TransactionSearch', build_transaction_search(options)
end