RefundPrimaryRecipient Property

Whether this recipient is the primary receiver.

Syntax

 adaptiverefund.getRefundPrimaryRecipient(index, [callback])

Default Value

FALSE

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 getRefundPrimaryRecipient([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 setRefundPrimaryRecipient([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

Whether this recipient is the primary receiver.

If true, that means this refund is for a chained payment. If this property is set to false, this is a refund for a simple or parallel payment.

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

This property is read-only and not available at design time.

Data Type

Boolean