RecipientAmount Property

Amount to be paid to the recipient.

Syntax

 adaptivepay.getRecipientAmount(index, [callback])
 adaptivepay.setRecipientAmount(index,  recipientAmount, [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 getRecipientAmount([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 setRecipientAmount([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

Amount to be paid to the recipient. This property is required.

Limitations: Must not exceed $10,000 USD in any currency. The decimal separator must be a period (.) and the thousands separator a comma (,). No currency symbol ($) is to be sent.

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

This property is not available at design time.

Data Type

String