The Bulk Account Close Process is essentially a batch version of calling /account/close repeatedly. To issue several requests to close accounts, use this process. Throttling mechanisms exist in the Helix API to ensure timely responses. See Batch Processing Overview for more information.

Basic Workflow

1. You upload a Bulk Account Close Request File
2. Helix processes it then uploads a Bulk Account Close Response File containing the results

Detailed Workflow

1. You upload a properly formatted Bulk Account Close Request File to sftp.corepro.io
2. Open a support ticket to request the file to be processed.
3. Within four days of receiving the request, Helix calls the /account/close functionality for each content row in the file, but in a vastly more efficient manner
4. Helix writes the results to a Bulk Account Close Response File and uploads it to sftp.corepro.io
5. You inspect this response file for success and failed counts, and process accordingly. NOTE: Only failed account close operations will appear in the content section of the response file

Bulk Account Close Request File Definition

The Bulk Account Close Request File is a file created by the client to perform the equivalent of several requests to the /account/close endpoint. Multiple files per day can be processed, typically on an hourly basis. It has the following properties:

1. Fixed-length
2. ANSI encoded
3. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
4. File must be uploaded to the relative directory of /BulkAccountClose/Request
5. File name follows a specific, case-insensitive pattern of: yyyyMMddhhmm_BULKACCOUNTCLOSE.txt
   • The date in the file name should be the creation date of the file.
   • For example, if the file name is 201501080015_BULKACCOUNTCLOSE.TXT, the data it contains will apply to Jan 8, 2015.
   • The header record contains an EffectiveDate field. This should be the same value as the CreatedDate field.

🚧

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 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 FileCreatedDate or FileEffectiveDate 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

Content Row

Take me to the Example Bulk Account Close Request File

Bulk Account Close Response File Definition

The Bulk Account Close Response File is created by Helix after Helix processes a Bulk Account Close Request File. It has the following properties:

1. Fixed-length
2. ANSI encoded
3. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
4. File will appear in the relative directory of /BulkAccountClose/Response
5. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_BULKACCOUNTCLOSERESPONSE.TXT
   • This file is an exception in the naming convention used by other files. The date in the file name is the exact same date as the one in the corresponding Bulk Account Close Request File. It is NOT the CreatedDate of the file.
   • For example, if the Bulk Account Close Request File name is 201501080015_BULKACCOUNTCLOSE.txt, the response file name will be 201501080015_BULKACCOUNTCLOSE.txt regardless of the actual CreatedDate or EffectiveDate
6. Only failed transactions will appear in the Content Row section. Successful transactions will not be represented with a content row but will be included in the SuccessCount tally.

🚧

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 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 FileCreatedDate or FileEffectiveDate 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

Content Row

Take me to the Example Bulk Account Close Response File