SyncPayeeName Property

Name of the payee to whom the given Id or ListId corresponds.

Syntax

 billpayment.getSyncPayeeName(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 getSyncPayeeName([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 setSyncPayeeName([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

Name of the payee to whom the given SyncPayeeId or SyncPayeeListId corresponds. This is required to be provided in :

• a payment request if payee detailed information is used to identify the payee (i.e., when PayeeId is not provided in the request when either PayBill or ModifyPayment methods are called);
• adding or modifying a payee (when the AddPayee or ModifyPayee methods are called).

After sending payment or add/modify payee requests, if the returned SyncPayeeIdScope is GLOBAL, the SyncPayeeName will contain the standard payee name returned by the server.

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

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

Data Type

String