SearchCriteriaTransactionClass Property

Search by the classification of the transaction.

Syntax

 transactionsearch.getSearchCriteriaTransactionClass([callback])
 transactionsearch.setSearchCriteriaTransactionClass( searchCriteriaTransactionClass, [callback])

Possible Values

  0 (tcAll), 
  1 (tcSent), 
  2 (tcReceived), 
  3 (tcMassPay), 
  4 (tcMoneyRequest), 
  5 (tcFundsAdded), 
  6 (tcFundsWithdrawn), 
  7 (tcPayPalDebitCard), 
  8 (tcPrimaryDebitCard), 
  9 (tcSecondaryDebitCard), 
  10 (tcReferral), 
  11 (tcFee), 
  12 (tcSubscription), 
  13 (tcDividend), 
  14 (tcBillpay), 
  15 (tcRefund), 
  16 (tcCurrencyConversions), 
  17 (tcBalanceTransfer), 
  18 (tcReversal), 
  19 (tcShipping), 
  20 (tcBalanceAffecting), 
  21 (tcECheck)

Default Value

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getSearchCriteriaTransactionClass([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setSearchCriteriaTransactionClass([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

Search by the classification of the transaction.

Valid classes are listed below:


tcAll (0)	All transaction classifications (default).
tcSent (1)	Only payments sent.
tcReceived (2)	Only payments received.
tcMassPay (3)	Only mass payments.
tcMoneyRequest (4)	Only money requests.
tcFundsAdded (5)	Only funds added to balance.
tcFundsWithdrawn (6)	Only funds withdrawn from balance.
tcPayPalDebitCard (7)	Only transactions involving a PayPal debit card.
tcPrimaryDebitCard (8)	Only transactions involving a primary debit card.
tcSecondaryDebitCard (9)	Only transactions involving a secondary debit card.
tcReferral (10)	Only transactions involving referrals.
tcFee (11)	Only transactions involving fees.
tcSubscription (12)	Only transactions involving subscriptions.
tcDividend (13)	Only transactions involving dividends.
tcBillpay (14)	Only transactions involving BillPay Transactions.
tcRefund (15)	Only transactions involving refunds.
tcCurrencyConversions (16)	Only transactions involving currency conversions.
tcBalanceTransfer (17)	Only transactions involving balance transfers.
tcReversal (18)	Only transactions involving BillPay reversals.
tcShipping (19)	Only transactions involving UPS shipping fees.
tcBalanceAffecting (20)	Only transactions that affect the account balance.
tcECheck (21)	Only transactions involving eCheck.

Data Type

Integer