SyncPayeeState Property
Payee's state This is required to be provided in : a payment request if payee detailed information is used to identify the payee (i.
Syntax
billpayment.getSyncPayeeState(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 getSyncPayeeState([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 setSyncPayeeState([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
Payee's state
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).
The index parameter specifies the index of the item in the array. 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