PaymentPeriod Property

The payment period.

Syntax

 adaptivepreapproval.getPaymentPeriod([callback])
 adaptivepreapproval.setPaymentPeriod( paymentPeriod, [callback])

Possible Values

  0 (ppNotSet), 
  1 (ppDaily), 
  2 (ppWeekly), 
  3 (ppBiWeekly), 
  4 (ppSemiMonthly), 
  5 (ppMonthly), 
  6 (ppAnnually)

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 getPaymentPeriod([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 setPaymentPeriod([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

The PaymentPeriod may be set to one of the following values:

Data Type

Integer