RecipientInvoiceId Property

The invoice number for the payment.

Syntax

 adaptivepay.getRecipientInvoiceId(index, [callback])
 adaptivepay.setRecipientInvoiceId(index,  recipientInvoiceId, [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 getRecipientInvoiceId([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 setRecipientInvoiceId([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 invoice number for the payment. The data in this property shows on the transaction details report. (Use the AdaptivePaymentDetails class to generate reports).

This property is optional.

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

This property is not available at design time.

Data Type

String