addAccountError(options)
|
Type |
Object function |
|
Description |
Records an error for an account specified in |
|
Returns |
void |
Example
context.addAccountError({
accountMappingKey: "12345",
failureReason: "Cannot connect to provider",
errorCode: "2000001200"
});
The properties embedded in the JSON string include the following:
-
accountMappingKey(String, required): The financial institution account's unique identifier. Must match an entry inaccountRequestsJSON. -
failureReason(String, optional): The error message for the failure. If provided, the account isn't included inaccountRequestsJSONwhengetTransactionDatais called. When the import is finished, it has a status of Partially Completed instead of Completed. If all accounts have a failure reason, the import is terminated with a failure. -
errorCode(String, optional): Standardized error code for account retrieval failure. Valid error codes are standardized and must match the codes listed in Bank Import Error Codes (Reference). All valid account-level error codes begin with "2". Null, undefined, or empty strings are not treated as error codes. Values that aren't part of the valid list are converted to "2000000000".