Schema

This file provides information on all issued cards.

Card files should include all newly created cards and any cards that have been updated.

For all optional fields where you do not plan to pass through data, please include the header and an empty value.

IDs

Field	Description	Required	Data Type
client_card_id	Unique ID of the card issued.	Required	string
account_id	Unique ID of an account created through the Account file.	Required	string
entity_id	Unique ID of a customer created through the Customer file or an entity created through the Entity API.	Required	string
client_card_product_name	The name of the card product in the client’s system.	Required	string

Field	Description	Required	Data Type
is_virtual	True if the card is a virtual card; false if physical.	Required	boolean
card_type	enum `hsa` `fsa` `consumer` `commercial`	Required	enum

Field	Description	Required	Data Type
created_at	Datetime the card was created.	Required	datetime ISO8601
card_status	enum `active` `closed` `inactive` `expired` A closed Card cannot be re-opened and Lead’s system will reject any additional changes or activity reported once it is in a `closed` status. If there is a chance that activity may still occur on the Card, use the `inactive` status until it is confirmed that no further activity will occur.	Required	enum
activated_at	Datetime the card was activated and able to charge transactions. Must be >= to created_at and < expiry_date, if expiry_date is present	Required	datetime ISO8601
expiry_date	Date the card expires.	Required	date `YYYY-MM-DD`
closed_at	Datetime the card was closed. Must be >= to created_at	Required if card_status = closed	datetime ISO8601
closed_reason	The reason for closing the card.	Required if card_status = closed	string
replaced_by	The card ID that replaced this card if expired, lost, or canceled.	Optional	string

Field	Description	Required	Data Type
generated_at	The day this file is generated. This should always be the date the file is sent to Lead Bank.	Required	datetime ISO8601
effective_at	The timestamp of when the related object(s) were polled to collect the information for this record.	Required	datetime ISO8601