SyncPaymentPayeeId Property

Server-assigned identifier to the payee this payment was sent to.

Syntax

 billpayment.getSyncPaymentPayeeId(index, [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 getSyncPaymentPayeeId([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 setSyncPaymentPayeeId([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

Server-assigned identifier to the payee this payment was sent to.

The SyncPaymentPayeeId is assigned by the payment system to a payee. There is no requirement though that all or any payees are assigned an identifier. This string uniquely identifies the payee in the list of payees.

Either SyncPaymentPayeeAggregate or SyncPaymentPayeeId can be returned in the response, but not both.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the SyncPaymentCount property.

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

Data Type

String