InstallmentCount Property

Total number of installments (installment transactions only).

Syntax

 fdmsdetailrecord.getInstallmentCount([callback])
 fdmsdetailrecord.setInstallmentCount( installmentCount, [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 getInstallmentCount([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 setInstallmentCount([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 is used when charging installment payments. The InstallmentCount indicates the total number of installments to be charged to the customer, and the InstallmentNumber indicates the current installment which is being charged. Installment payments can only be made for card-not-present transactions initiated by the FDMSECommerce class.

To settle a transaction authorized with the ttInstallment TransactionType, you must use the FDMSDetailRecord class to add the number of this installment and the total count of all installments to be made. For instance, if the purchase was for "Three easy payments of $19.95", and this is the first payment, then the installment number will be 1, and the installment count 3. An example is included below:

  FDMSECommerce.TransactionType = ttInstallment
  FDMSECommerce.TransactionAmount = "1995"
  FDMSECommerce.Authorize()

  FDMSDetailRecord.ParseAggregate FDMSECommerce.GetDetailAggregate()
  FDMSDetailRecord.InstallmentCount = 3
  FDMSDetailRecord.InstallmentNumber = 1
  
  
  FDMSSettle.DetailRecordAggregate(5) = FDMSDetailRecord.GetDetailAggregate()

Data Type

Integer