AppliedToPaymentAmount Property

Represents the amount assigned to a particular bill payment.

Syntax

 receivepayment.getAppliedToPaymentAmount(index, [callback])
 receivepayment.setAppliedToPaymentAmount(index,  appliedToPaymentAmount, [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 getAppliedToPaymentAmount([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 setAppliedToPaymentAmount([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

Represents the amount assigned to a particular bill payment. The sum of all AppliedToPaymentAmounts in any given transaction must not be greater than the total amount.

Note, if submitting an update and no AppliedToPaymentAmount is specified, the contents of the AppliedToAmount property will be used instead.

The size of the array is controlled by the AppliedToCount property.

This property is not available at design time.

Data Type

String