Card Status File

A listing of of card status updates for your program as of the file’s effective timestamp.

Card Status File Definition

The Card Status File is generated by Helix on a daily basis. It has the following properties:

  1. Exactly one fixed-length header line
  2. Zero or more fixed-length content lines
  3. Fixed-width format. Records may exceed the documented length; consumers must ignore trailing data beyond the last defined field.
  4. UTF-8 encoded
  5. Line endings are environment-dependent (commonly \r\n on Windows and \n on Unix-based systems). Consumers should normalize line endings during processing if required.
  6. File will be available in the relative directory of /CardStatus
  7. File name follows a specific, case-sensitive pattern of: yyyyMMddHHmm_CARDSTATUS.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 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

Property

Data Type (Length)

Alignment

Start Position

Description

Record Type

string (1)

Left

1

The flag for the header row. Will always be H.

File Name

string (50)

Left

2

The name of this request file excluding path. Will be named following this pattern: yyyyMMddhhmm_CARDSTATUS.TXT Example: 202601181430_CARDSTATUS.TXT

Record Count

integer (10)

Right

52

The number of records represented within the file. This field is zero-padded on the left side. Example: 0000000872

File Created Date

string (34)

Left

62

The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines

File Effective Date

string (34)

Left

96

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 (Length)

Alignment

Start Position

Description

Card Id

integer (10)

Right

1

The unique identifier for the card that the transaction occurred against. This field is zero-padded on the left side. Example: 0000000872

Card Tag

string (50)

Right

11

A client-supplied unique identifier for the customer. This corresponds to the tag property on the card object, and may be empty as it is an optional property.

Customer Id

integer (10)

Right

61

The unique identifier for the customer who has access to the account. See PrimaryCustomerId for more information. This field is zero-padded on the left side. Example: 0000000872

Customer Tag

string (50)

Right

71

The tag property of the customer object.

Card Status Description

string (50)

Left

121

Human-readable description of the card’s status. See card.status for a list of valid values.

{ "file_type": "fixed_length" }