PayPal Integrator V5 - Online Help
PayPal Integrator V5
Questions / Feedback?

SearchCriteriaStatus Property

Search by status.

Syntax

 transactionsearch.getSearchCriteriaStatus([callback])
 transactionsearch.setSearchCriteriaStatus( searchCriteriaStatus, [callback])

Possible Values

  0 (sNone), 
  1 (sPending), 
  2 (sProcessing), 
  3 (sSuccess), 
  4 (sDenied), 
  5 (sReversed)

Default Value

0


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 getSearchCriteriaStatus([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 setSearchCriteriaStatus([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 status.

Valid payment statuses are listed below:

sNone (0)No status.
sPending (1)The payment is pending. See PaymentPendingReason for more information.
sProcessing (2)A Payment is currently being processed
sSuccess (3)The payment has been completed and the funds have been added successfully to your account balance.
sDenied (4)You, the merchant, denied the payment. This will only happen if the payment was previously pending due to one of these PaymentPendingReasons.
sReversed (5)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.

Data Type

Integer

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 5.0.6240.0