The Helix API is designed to handle typical web usage patterns. That is, human users clicking on website links and subsequently performing typical human user volumes of Helix API calls. To enforce this, the throttling mechanism detailed in API Call Limit was introduced to ensure the health of the system as a whole.
However, with any system integration, there are times when mass quantities of data need to be transferred. Helix supports this need via the following files:
|File Type||Delivery Frequency||Summary|
|Account Balance File||Once daily||Contains basic account information (including balances) for all accounts in an |
|ACH Transaction File||Once daily (default) or hourly (upon request)||Contains all ACH transactions that posted on a given day/hour|
|Admin Activity Files||Multiple times per day||Contains Admin Portal activity that has occurred since the previous file|
|Archived Customer Extract File||Once daily||Contains all Customers in Helix for a given program that moved to |
|Bulk Account Close Process||As Requested|
Note: This file is processed manually. Users must open a support ticket for the file to be processed. Allow up to 4 business days.
|Process large numbers of /account/close API calls|
|Bulk Account Lock Process||Multiple times per day||Process large numbers of /account/lock API calls|
|Bulk Account Unlock Process||Multiple times per day||Process large numbers of /account/unlock API calls|
|Bulk Transfer Process||Multiple times per day||Process large numbers of /transfer/create API calls|
|Card Event Notification File||Multiple times per day||Contains debit card properties which tie back to events in the corresponding Event Notification File|
|Card Transaction File||Once daily||Contains all card transactions on a given day|
|Customer File||Once daily||Contains basic customer information for all customers in a |
|Customer Registration File||Once daily||Contains all newly registered customers|
|Event Notification File||Multiple times per day||Contains all notable events that have occurred since the previous event notification file|
|External Account File||Once daily||Contains all external accounts for customers in a |
|Posted Transaction File||Once daily||Contains all transactions that posted on a given day|
|Recurring Contribution Process||Once daily||Outlines the process for configuring and managing recurring deposits into Helix accounts|
|Statement Event Notification File||Once daily||Contains statement properties which tie back to events in the corresponding Event Notification File|
|Trial Balance File||Once daily||A listing of all accounts and program accounts|
If your organization has the need to perform a large volume of requests to any other routes in the Helix API, or access to other data points within Helix, please contact us to discuss.
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as being 872 bytes per line, receiving a file with 984 bytes per line should not disrupt your processing. This applies to both Header and Content lines.
File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the
FileEffectiveDatecontained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.
Updated over 1 year ago