SyncPaymentStatus Property
Payment processing status.
Syntax
billpayment.getSyncPaymentStatus(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 getSyncPaymentStatus([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 setSyncPaymentStatus([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
Payment processing status.
The possible values of this property are as follows:
Value | Meaning |
WILLPROCESSON | Will be processed on SyncPaymentDate |
PROCESSEDON | Was processed on SyncPaymentDate |
NOFUNDSON | There were insufficient funds to pay this bill as of SyncPaymentDate |
FAILEDON | The attempt to make a payment failed on SyncPaymentDate for unspecified reasons |
CANCELEDON | the request to make a payment was canceled by the user on SyncPaymentDate |
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