External Account File
A listing of all External Accounts in Helix for a given program for all customers with these statuses (as of the effective date of the file):
- Moved to a
Verified
status on that date after successfully completing registration - Remained in a
Verified
status during the entire date - Changed from a
Verified
status to anArchived
status on that date - Changed from a
Verified
status to aDeceased
status on that date
External Account File Definition
The External Account File is created by Helix on a daily basis. It has the following properties:
- Exactly one tab-delimited header line.
- Zero or more tab-delimited content lines.
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - This file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns.
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - File will be available in the relative directory of
/ExternalAccount
- File name follows a specific, case-sensitive pattern of:
yyyyMMdd_EXTERNALACCOUNTEXPORT.TXT
Format Disclaimer
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.Implementation Note
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 having 30 tabs per line, receiving a file with 31 or more 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 theFileCreatedDate
orFileEffectiveDate
contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.
Header Row
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
FileName | string (50) | 0 | The name of this file excluding path. Format: yyyyMMdd_EXTERNALACCOUNTEXPORT.TXT Example: 20140716_EXTERNALACCOUNTEXPORT.TXT |
RecordCount | integer (10) | 1 | The number of records represented within the file. This field is zero-padded on the left side. Example: 0000000872 |
FileCreatedDate | datetime (34) | 2 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | 3 | The date to which the data in the file pertains. Follows same format as API. Example: 2014-10-19T23:59:59.999-05:00 See data format guidelines |
Content Row
Property | Data Type (Max Length) | Tab Offset | Description |
---|---|---|---|
ExternalAccountId | integer (10) | 0 | The externalAccountId property of the externalAccount object. |
CustomerId | integer (10) | 1 | The customerId property of the externalAccount object. |
Tag | string (50) | 2 | The tag property of the externalAccount object. |
Name | string (50) | 3 | The name property of the externalAccount object. |
RoutingNumber | string (10) | 4 | The routingNumber property of the externalAccount object. |
RoutingNumberMasked | string (10) | 5 | The routingNumberMasked property of the externalAccount object. |
AccountNumber | string (17) | 6 | The accountNumber property of the externalAccount object. |
AccountNumberMasked | string (17) | 7 | The accountNumberMasked property of the externalAccount object. |
Type | string (50) | 8 | The type property of the externalAccount object. |
NickName | string (50) | 9 | The nickName property of the externalAccount object. |
Status | string (20) | 10 | The status property of the externalAccount object. |
StatusDate | datetime | 11 | The date the externalAccount object had a status change. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00 See data format guidelines |
LastModifiedDate | datetime | 12 | The date the externalAccount object was last modified. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00 See data format guidelines |
NOCCode | string (10) | 13 | The nocCode property of the externalAccount object. |
IsActive | boolean | 14 | The isActive property of the externalAccount object. |
IsLocked | boolean | 15 | The isLocked property of the externalAccount object. |
LockedDate | datetime | 16 | The date the externalAccount object was locked. Follows same format as API. Example: 2014-10-20T23:59:59.999-05:00 See data format guidelines |
LockedReason | string (255) | 17 | The lockedReason property of the externalAccount object. |
CustomField1 | string (50) | 18 | The customField1 property of the externalAccount object. |
CustomField2 | string (50) | 19 | The customField2 property of the externalAccount object. |
CustomField3 | string (50) | 20 | The customField3 property of the externalAccount object. |
CustomField4 | string (50) | 21 | The customField4 property of the externalAccount object. |
CustomField5 | string (50) | 22 | The customField5 property of the externalAccount object. |
BusinessName | string(100) | 23 | The name of the business to which the external account belongs |
Take me to the Example External Account File
Updated about 1 year ago