Status Property

The status of the profile.

Syntax

 recurringpayments.getStatus([callback])

Possible Values

  0 (psActive), 
  1 (psPending), 
  2 (psCancelled), 
  3 (psSuspended), 
  4 (psExpired)

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 getStatus([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 setStatus([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

This property will contain the status of the profile after a call to GetProfile.

This property is read-only.

Data Type

Integer