Card file schema

The Card file contains events related to cards and the card lifecycle. Each row represents one card event. For file naming, format and conventions, see Working with the files.

Column	Data type	Allowed values / format	Description
`event_type`	string	`card_created`, `card_updated`, `card_closed`	Type of card event represented by the row.
`event_created_at`	datetime	ISO 8601 datetime	Date and time when the event occurred or was emitted.
`card_event_id`	string	String	Unique identifier of the card event.
`card_id`	UUID	UUID	Unique identifier of the card.
`card_created_at`	datetime	ISO 8601 datetime	Date and time when the card was created.
`card_updated_at`	datetime	ISO 8601 datetime	Date and time when the card entity was last updated.
`program_id`	UUID	UUID	Card program associated with the card.
`cardholder_id`	UUID	UUID	Cardholder associated with the card.
`account_id`	string	1–36 characters; letters, numbers, hyphen	Account associated with the card.
`role`	string	`MAIN_CARD`, `CARD_APPLICATION`	Role of the card. Multi-application cards have one main card and multiple card applications.
`main_card_id`	UUID	UUID / empty	Main card ID. Populated if the card is part of a card application.
`card_configuration_code`	string	1–36 characters; letters, numbers, underscore, hyphen	Unique code identifying the card configuration.
`card_configuration_type`	string	`DEBIT`, `CREDIT`, `COMBO`	Type of card configuration.
`card_scheme`	string	`MASTERCARD`, `VISA`	Card scheme.
`masked_pan`	string	Masked value	Masked version of the primary account number.
`pin_status`	string	`GENERATED`, `WAITING`, `SET`, `INHERITED`	PIN status of the card.
`card_status`	string	`ACTIVE`, `BLOCKED`, `BLOCKED_SUSPECTED_FRAUD`, `CLOSED_DUE_TO_FRAUD`, `CLOSED_LOST`, `CLOSED_STOLEN`, `CLOSED`, `CLOSED_EXPIRED`	Current card status after the event.
`automatic_renewal`	boolean	`true`, `false`	Indicates whether automatic renewal is enabled.
`digital_layout_code`	string	1–36 characters; letters, numbers, hyphen	Digital layout code for the card.
`update_count`	integer	Integer	Version number of the card entity.
`plastic_embossing_name`	string	1–26 characters; letters, numbers, spaces and limited punctuation	Name embossed on the card.
`plastic_preferred_card_address_address1`	string	1–255 characters; no leading/trailing whitespace	First line of the preferred card delivery address.
`plastic_preferred_card_address_address2`	string	Max 255 characters; no leading/trailing whitespace / empty	Second line of the preferred card delivery address.
`plastic_preferred_card_address_address3`	string	Max 255 characters; no leading/trailing whitespace / empty	Third line of the preferred card delivery address.
`plastic_preferred_card_address_address4`	string	Max 255 characters; no leading/trailing whitespace / empty	Fourth line of the preferred card delivery address.
`plastic_preferred_card_address_city`	string	1–255 characters; no leading/trailing whitespace	City of the preferred card delivery address.
`plastic_preferred_card_address_country`	string	ISO 3166-1 alpha-3 country code	Country of the preferred card delivery address.
`plastic_preferred_card_address_region`	string	Max 32 characters	Region of the preferred card delivery address.
`plastic_preferred_card_address_zip_code`	string	1–32 characters; no leading/trailing whitespace	Postal or ZIP code of the preferred card delivery address.
`plastic_preferred_card_delivery_type`	string	`MAIL`, `COURIER`, `CUSTOM_1`, `CUSTOM_2`, `CUSTOM_3`, `CUSTOM_4`, `CUSTOM_5`	Delivery method for the card. `CUSTOM` values are shipping methods agreed between you and the card bureau.
`plastic_preferred_pin_address_address1`	string	1–255 characters; no leading/trailing whitespace	First line of the preferred PIN delivery address.
`plastic_preferred_pin_address_address2`	string	Max 255 characters; no leading/trailing whitespace / empty	Second line of the preferred PIN delivery address.
`plastic_preferred_pin_address_address3`	string	Max 255 characters; no leading/trailing whitespace / empty	Third line of the preferred PIN delivery address.
`plastic_preferred_pin_address_address4`	string	Max 255 characters; no leading/trailing whitespace / empty	Fourth line of the preferred PIN delivery address.
`plastic_preferred_pin_address_city`	string	1–255 characters; no leading/trailing whitespace	City of the preferred PIN delivery address.
`plastic_preferred_pin_address_country`	string	ISO 3166-1 alpha-3 country code	Country of the preferred PIN delivery address.
`plastic_preferred_pin_address_region`	string	Max 32 characters	Region of the preferred PIN delivery address.
`plastic_preferred_pin_address_zip_code`	string	1–32 characters; no leading/trailing whitespace	Postal or ZIP code of the preferred PIN delivery address.
`plastic_preferred_pin_delivery_type`	string	`MAIL`, `COURIER`, `EPIN`	Delivery method for the card PIN. `EPIN` means the PIN is sent digitally.
`plastic_manufacturer_id`	UUID	UUID	Unique identifier of the card manufacturer.
`plastic_external_layout_code`	string	1–32 characters; letters, numbers, hyphen, underscore	Code forwarded to the embossing house identifying the plastic layout used for printing the card.
`plastic_created_at`	datetime	ISO 8601 datetime	Date and time when the plastic entity was created.
`plastic_updated_at`	datetime	ISO 8601 datetime	Date and time when the plastic entity was last updated.
`card_versions`	string	String array in a single column	Card versions associated with the card, ordered by sequence number ascending. The underlying value is an array, delivered as a string. Each entry is JSON encoded and carries `status`, `expiration_time`, `renewal_date`, `sequence_number`, `key_set_id`, `created_at` and `updated_at`.
`multi_application_properties_application_name`	string	1–16 characters; letters and spaces	Name of the application. Only applicable to multi-application cards.
`multi_application_properties_application_index`	integer	Integer	Index of the application.
`multi_application_properties_contact_priority_level`	integer	Integer, minimum 0	Contact priority level of the card application.
`multi_application_properties_contactless_priority_level`	integer	Integer, minimum 0	Contactless priority level of the card application.
`multi_application_properties_printed`	boolean	`true`, `false`	Indicates whether the specific card application should be printed.
`multi_application_properties_chip_enabled`	boolean	`true`, `false`	Indicates whether the card application should be visible in the card terminal.
`additional_values`	object / key-value map	Key-value map in a single column, up to 30 pairs	Additional key-value pairs included in the embossing file sent to the card manufacturer. Delivered as a single JSON object.
`fee_config_id`	string	1–36 characters; letters, numbers, underscore, hyphen / empty	Fee configuration applied to the card, overriding the program default. Empty when the feature is not enabled for you.

Getting Started

Cards

Cardholders

PIN

Digital Wallets

Transaction Lifecycle

Data

Spend Controls

Exchange Rates

Card file schema