GetStatus Method
Obtains the current processing status of a payment.
Syntax
ANSI (Cross Platform) int GetStatus(const char* lpszPaymentId); Unicode (Windows) INT GetStatus(LPCWSTR lpszPaymentId);
- (void)getStatus:(NSString*)paymentId;
#define MID_BILLPAYMENT_GETSTATUS 6 IPWORKSOFX_EXTERNAL int IPWORKSOFX_CALL IPWorksOFX_BillPayment_Do(void *lpObj, int methid, int cparam, void *param[], int cbparam[], int64 *lpllVal);
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) |
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)