PHP Class PayPal\PayPalAPI\TransactionSearchRequestType

No wildcards are allowed. Required
Inheritance: extends PayPal\EBLBaseComponents\AbstractRequestType
Mostrar archivo Open project: paypal/merchant-sdk-php Class Usage Examples

Public Properties

Property Type Description
$Amount PayPal\CoreComponentTypes\BasicAmountType 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.
$AuctionItemNumber string 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.
$CardNumber string
$CurrencyCode string Search by currency codeOptional
$EndDate The latest transaction date to be included in the search Optional
$InvoiceID string OptionalThe value for InvoiceID must exactly match an invoice identification number. No wildcards are allowed. Character length and limitations: 127 single-byte characters maximum
$Payer string Search by the buyer's email address OptionalCharacter length and limitations: 127 single-byte alphanumeric characters
$PayerName PayPal\EBLBaseComponents\PersonNameType 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.
$ProfileID string Search by Recurring Payment Profile id. The ProfileID is returned as part of the CreateRecurringPaymentsProfile API response. Optional
$ReceiptID string Search by the PayPal Account Optional receipt IDOptional
$Receiver string 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
$StartDate No wildcards are allowed. Required
$Status string 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.
$TransactionClass string 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.
$TransactionID string Search by the transaction ID. OptionalThe returned results are from the merchant's transaction records. Character length and limitations: 19 single-byte characters maximum

Public Methods

Method Description
__construct ( $StartDate = null ) Constructor with arguments

Method Details

__construct() public method

Constructor with arguments
public __construct ( $StartDate = null )

Property Details

$Amount public_oe property

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.
public BasicAmountType,PayPal\CoreComponentTypes $Amount
return PayPal\CoreComponentTypes\BasicAmountType

$AuctionItemNumber public_oe property

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.
public string $AuctionItemNumber
return string

$CardNumber public_oe property

public string $CardNumber
return string

$CurrencyCode public_oe property

Search by currency codeOptional
public string $CurrencyCode
return string

$EndDate public_oe property

The latest transaction date to be included in the search Optional
public $EndDate

$InvoiceID public_oe property

OptionalThe value for InvoiceID must exactly match an invoice identification number. No wildcards are allowed. Character length and limitations: 127 single-byte characters maximum
public string $InvoiceID
return string

$Payer public_oe property

Search by the buyer's email address OptionalCharacter length and limitations: 127 single-byte alphanumeric characters
public string $Payer
return string

$PayerName public_oe property

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.
public PersonNameType,PayPal\EBLBaseComponents $PayerName
return PayPal\EBLBaseComponents\PersonNameType

$ProfileID public_oe property

Search by Recurring Payment Profile id. The ProfileID is returned as part of the CreateRecurringPaymentsProfile API response. Optional
public string $ProfileID
return string

$ReceiptID public_oe property

Search by the PayPal Account Optional receipt IDOptional
public string $ReceiptID
return string

$Receiver public_oe property

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
public string $Receiver
return string

$StartDate public_oe property

No wildcards are allowed. Required
public $StartDate

$Status public_oe property

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.
public string $Status
return string

$TransactionClass public_oe property

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.
public string $TransactionClass
return string

$TransactionID public_oe property

Search by the transaction ID. OptionalThe returned results are from the merchant's transaction records. Character length and limitations: 19 single-byte characters maximum
public string $TransactionID
return string