CollectedAmount Property

The total current collected amount.

Syntax

 recurringpayments.getCollectedAmount([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 getCollectedAmount([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 setCollectedAmount([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 total amount that has been collected by scheduled payments as returned by the server after a call to GetProfile.

This value must not exceed $10,000 USD in any currency.

It will also not contain any currency symbols, must have two decimal places separated by a period (.), and optionally a comma (,) separating the thousands digits.

This property is read-only.

Data Type

String