GetStatement Method
Downloads statement for a credit card account.
Syntax
ccstatement.getStatement([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
This method generates the Signon and Credit Card Statement request page, submits it to the financial institution via secure HTTPS Post, and receives and parses the bank statement.
The following properties should be set when this method is called:
- FIId (required)
- FIOrganization (required)
- FIUrl (required)
- OFXAppId (required)
- OFXAppVersion (required)
- OFXVersion (required if 2.x OFX version is the one supported by your FI)
- OFXUser (required)
- OFXPassword (required)
- CardNumber (required)
Individual transactions are downloaded with the statement. You may constrain this transaction list by setting the StartDate and EndDate properties. The server will use default values if no dates are supplied.
The following read-only properties are populated as a result of parsing the statement response: