getTransactionData()
Function Declaration |
|
Type |
Interface function |
Description |
This function enables the plug-in to invoke a Financial Institution Parser Plug-in or Bank Statement Parser Plug-in to parse content into transactions. This happens when a bank data import is initiated.
Note:
For a successful import of bank or credit card data, you need at least one active linked account on the format profile record. |
Returns |
void |
Input Parameters |
context – a JavaScript object with the following properties: |
Example
function getTransactionData(context)
{
var configurationId = context.pluginConfiguration.getConfigurationFieldValue({fieldName: "configuration_id"});
var configuration = loadConfiguration(configurationId)
var accountRequests = JSON.parse(context.accountRequestsJSON);
if (accountRequests != null) {
accountRequests.forEach(function (accountRequest) {
var accountId = accountRequest.accountMappingKey;
var fromDateTime = accountRequest.dataStartTime;
var toDateTime = accountRequest.dataEndTime;
var downloadedData = "... Retrieve the account data using a web service request or a file transfer...";
context.addDataChunk({dataChunk: downloadedData});
});
}
context.returnAccountRequestsJSON({accountsJson: context.accountRequestsJSON});
}
If you want the plug-in to initiate a bank data import retry, make sure isRetryAllowed() is true and then call retry().
if (context.isRetryAllowed()) {
context.retry({deltaMinutesLater: 30, currentFailureReason: "Timed out"});
}
Reasons why you may want to initiate an import retry can include the following:
-
Your financial institution goes down.
-
There is too much data.
-
There was a time-out for the import.
An import retry is initiated during the import process. retry() causes the current import job to be marked as failed, and then initiates a retry.