SyncPaymentPayeeListId Property

Server-assigned payee list record ID for the payee this payment was sent to.

Syntax

 billpayment.getSyncPaymentPayeeListId(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 getSyncPaymentPayeeListId([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 setSyncPaymentPayeeListId([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 payee list record ID for the payee this payment was sent to.

This is uniquely assigned by the server to each entry in a payee list. In systems that do not assign a SyncPaymentPayeeId, the SyncPaymentPayeeListId is another identifier that can be used to reference every payee making sure that the user can correctly link payments to their payees. This identifier is valid as long as the user's payee list includes the payee it identifies, even if the server assigns a SyncPaymentPayeeId to this payee.

This is assigned by the server to that payee when an add payee request (via AddPayee method) or bill payment request (via PayBill method) has been sent.

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