GetStatus Method
Obtains the current processing status of a payment.
Syntax
billpayment.getStatus(paymentId, [callback])
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 this 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
The PaymentId parameter identifies the payment you want to obtain the status for. This is the id returned by the server at the time the payment was scheduled (that was stored in PaymentId).
The following properties should be set when this method is called:
| FIUrl | (required) |
| FIId | (required) |
| FIOrganization | (required) |
| OFXAppId | (required) |
| OFXAppVersion | (required) |
| OFXUser | (required) |
| OFXPassword | (required) |
Upon successful response, the server will return the following:
| PaymentStatus | |
| PaymentDateProcessed | |
| PaymentCheckNumber | (optional) |