RecurInstallments Property

An integer indicating the maximum number of permitted authorizations for installment payments.

Syntax

 mpi.getRecurInstallments([callback])
 mpi.setRecurInstallments( recurInstallments, [callback])

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 getRecurInstallments([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 setRecurInstallments([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

An integer indicating the maximum number of permitted authorizations for installment payments. This field must be included if the merchant and cardholder have agreed to installment payments.

This property is not available at design time.

Data Type

String