card_data.h File Reference

Description

Card data.

Object type card_data.

Functions
ta_e_result_code_t	ta_card_data_get_pos_entry_mode (ta_object_t card_data, ta_e_pos_entry_mode_t *pos_entry_mode)
	POS entry mode. More...
ta_e_result_code_t	ta_card_data_get_aid (ta_object_t card_data, ta_object_t *aid)
	Application identifier. More...
ta_e_result_code_t	ta_card_data_get_acc (ta_object_t card_data, ta_object_t *acc)
	Application currency code. More...
ta_e_result_code_t	ta_card_data_get_card_number (ta_object_t card_data, ta_object_t *card_number)
	Card number. More...
ta_e_result_code_t	ta_card_data_get_card_number_printable (ta_object_t card_data, ta_object_t *card_number_printable)
	Card number that should be printed on a merchant receipt. More...
ta_e_result_code_t	ta_card_data_get_card_number_printable_cardholder (ta_object_t card_data, ta_object_t *card_number_printable_cardholder)
	Card number that should be printed on a cardholder receipt. More...
ta_e_result_code_t	ta_card_data_get_card_number_enc (ta_object_t card_data, ta_object_t *card_number_enc)
	Encrypted card number. More...
ta_e_result_code_t	ta_card_data_get_card_number_enc_key_index (ta_object_t card_data, int *card_number_enc_key_index)
	Card number encryption key index. More...
ta_e_result_code_t	ta_card_data_get_card_expiry_date (ta_object_t card_data, ta_object_t *card_expiry_date)
	Card expiration date. More...
ta_e_result_code_t	ta_card_data_get_brand_name (ta_object_t card_data, ta_object_t *brand_name)
	Card brand name. More...
ta_e_result_code_t	ta_card_data_get_tender_name (ta_object_t card_data, ta_object_t *tender_name)
	Card tender name. More...
ta_e_result_code_t	ta_card_data_get_card_track_datas (ta_object_t card_data, ta_object_t *card_track_datas)
	List of card track data if present. More...
ta_e_result_code_t	ta_card_data_get_loyalty_information (ta_object_t card_data, ta_object_t *loyalty_information)
	Loyalty information if present. Keyed by loyalty type string. More...
ta_e_result_code_t	ta_card_data_get_card_ref (ta_object_t card_data, ta_object_t *card_ref)
	Petrol: Reference from the card. More...
ta_e_result_code_t	ta_card_data_get_processing_disposition (ta_object_t card_data, ta_e_processing_disposition_t *processing_disposition)
	Petrol: Defines if the ECR or EFT is responsible for further trx handling. More...
ta_e_result_code_t	ta_card_data_get_language (ta_object_t card_data, ta_object_t *language)
	Card language. More...
ta_e_result_code_t	ta_card_data_get_card_country_code (ta_object_t card_data, ta_object_t *country_code)
	Card country code. More...
ta_e_result_code_t	ta_card_data_get_terminal_country_code (ta_object_t card_data, ta_object_t *country_code)
	Terminal country code. More...
ta_e_result_code_t	ta_card_data_get_uid (ta_object_t card_data, ta_object_t *uid)
	Uid of the contactless card. More...
ta_e_result_code_t	ta_card_data_get_asrpd (ta_object_t card_data, ta_object_t *asrpd)
	Asrpd. More...
ta_e_result_code_t	ta_card_data_get_card_product_type (ta_object_t card_data, ta_e_card_product_type_t *card_product_type)
	Card product type. More...
ta_e_result_code_t	ta_card_data_get_card_type (ta_object_t card_data, ta_object_t *card_type)
	Petrol: Card type. More...
ta_e_result_code_t	ta_card_data_get_cardholder (ta_object_t card_data, ta_object_t *cardholder)
	Petrol: Cardholder. More...
ta_e_result_code_t	ta_card_data_get_account_type (ta_object_t card_data, ta_e_account_type_t *account_type)
	Account. More...
ta_e_result_code_t	ta_card_data_get_emv_par (ta_object_t card_data, ta_object_t *emv_par)
	EMV PAR. More...
ta_e_result_code_t	ta_card_data_get_token_pan (ta_object_t card_data, ta_object_t *token_pan)
	Token PAN. More...
ta_e_result_code_t	ta_card_data_get_token_pan_type (ta_object_t card_data, ta_e_token_pan_type_t *token_pan_type)
	Token PAN type. More...

Function Documentation

ta_card_data_get_acc()

ta_e_result_code_t ta_card_data_get_acc	(	ta_object_t	card_data,
		ta_object_t *	acc
	)

Application currency code.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	acc	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to acc.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	acc is null-pointer.

ta_card_data_get_account_type()

ta_e_result_code_t ta_card_data_get_account_type	(	ta_object_t	card_data,
		ta_e_account_type_t *	account_type
	)

Account.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	account_type	Pointer to variable to write object instance to.

Return values

ta_c_rc_ok	Object instance written to card_product_type.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	account_type is null-pointer.

ta_card_data_get_aid()

ta_e_result_code_t ta_card_data_get_aid	(	ta_object_t	card_data,
		ta_object_t *	aid
	)

Application identifier.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	aid	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to aid.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	aid is null-pointer.

ta_card_data_get_asrpd()

ta_e_result_code_t ta_card_data_get_asrpd	(	ta_object_t	card_data,
		ta_object_t *	asrpd
	)

Asrpd.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	asrpd	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to asrpd.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	asrpd is null-pointer.

ta_card_data_get_brand_name()

ta_e_result_code_t ta_card_data_get_brand_name	(	ta_object_t	card_data,
		ta_object_t *	brand_name
	)

Card brand name.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	brand_name	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to brand_name.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	brand_name is null-pointer.

ta_card_data_get_card_country_code()

ta_e_result_code_t ta_card_data_get_card_country_code	(	ta_object_t	card_data,
		ta_object_t *	country_code
	)

Card country code.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	country_code	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to country_code.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	country_code is null-pointer.

ta_card_data_get_card_expiry_date()

ta_e_result_code_t ta_card_data_get_card_expiry_date	(	ta_object_t	card_data,
		ta_object_t *	card_expiry_date
	)

Card expiration date.

Only for Non-PCI applications and if available to the terminal.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_expiry_date	Pointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_expiry_date.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_expiry_date is null-pointer.

ta_card_data_get_card_number()

ta_e_result_code_t ta_card_data_get_card_number	(	ta_object_t	card_data,
		ta_object_t *	card_number
	)

Card number.

Only for Non-PCI applications and if available to the terminal.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_number	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_number.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_number is null-pointer.

ta_card_data_get_card_number_enc()

ta_e_result_code_t ta_card_data_get_card_number_enc	(	ta_object_t	card_data,
		ta_object_t *	card_number_enc
	)

Encrypted card number.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_number_enc	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_number_enc.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_number_enc is null-pointer.

ta_card_data_get_card_number_enc_key_index()

ta_e_result_code_t ta_card_data_get_card_number_enc_key_index	(	ta_object_t	card_data,
		int *	card_number_enc_key_index
	)

Card number encryption key index.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_number_enc_key_index	Pointer to variable to write value to. Value is 0 if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_number_enc_key_index.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_number_enc_key_index is null-pointer.

ta_card_data_get_card_number_printable()

ta_e_result_code_t ta_card_data_get_card_number_printable	(	ta_object_t	card_data,
		ta_object_t *	card_number_printable
	)

Card number that should be printed on a merchant receipt.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_number_printable	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_number_printable.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_number_printable is null-pointer.

ta_card_data_get_card_number_printable_cardholder()

ta_e_result_code_t ta_card_data_get_card_number_printable_cardholder	(	ta_object_t	card_data,
		ta_object_t *	card_number_printable_cardholder
	)

Card number that should be printed on a cardholder receipt.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_number_printable_cardholder	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_number_printable_cardholder.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_number_printable_cardholder is null-pointer.

ta_card_data_get_card_product_type()

ta_e_result_code_t ta_card_data_get_card_product_type	(	ta_object_t	card_data,
		ta_e_card_product_type_t *	card_product_type
	)

Card product type.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_product_type	Pointer to variable to write object instance to.

Return values

ta_c_rc_ok	Object instance written to card_product_type.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_product_type is null-pointer.

ta_card_data_get_card_ref()

ta_e_result_code_t ta_card_data_get_card_ref	(	ta_object_t	card_data,
		ta_object_t *	card_ref
	)

Petrol: Reference from the card.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_ref	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_ref.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_ref is null-pointer.

ta_card_data_get_card_track_datas()

ta_e_result_code_t ta_card_data_get_card_track_datas	(	ta_object_t	card_data,
		ta_object_t *	card_track_datas
	)

List of card track data if present.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_track_datas	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type card_track_data.

Return values

ta_c_rc_ok	Object instance written to card_track_datas.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_track_datas is null-pointer.

ta_card_data_get_card_type()

ta_e_result_code_t ta_card_data_get_card_type	(	ta_object_t	card_data,
		ta_object_t *	card_type
	)

Petrol: Card type.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	card_type	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to card_type.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	card_type is null-pointer.

ta_card_data_get_cardholder()

ta_e_result_code_t ta_card_data_get_cardholder	(	ta_object_t	card_data,
		ta_object_t *	cardholder
	)

Petrol: Cardholder.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	cardholder	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to asrpd.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	cardholder is null-pointer.

ta_card_data_get_emv_par()

ta_e_result_code_t ta_card_data_get_emv_par	(	ta_object_t	card_data,
		ta_object_t *	emv_par
	)

EMV PAR.

The EMV PAR "may be used to link transactions initiated on Payment Tokens with transactions initiated on the underlying PAN", which can be used in a transaction response to be able the identify if the transaction e.g. with a used token PAN is related to a previous transaction performed with the underlying PAN. If so, both transaction responses will contain the same value in the EmvPar field.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	emv_par	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to asrpd.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	emv_par is null-pointer.

ta_card_data_get_language()

ta_e_result_code_t ta_card_data_get_language	(	ta_object_t	card_data,
		ta_object_t *	language
	)

Card language.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	language	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to language.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	language is null-pointer.

ta_card_data_get_loyalty_information()

ta_e_result_code_t ta_card_data_get_loyalty_information	(	ta_object_t	card_data,
		ta_object_t *	loyalty_information
	)

Loyalty information if present. Keyed by loyalty type string.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	loyalty_information	Pointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys and values both of type string.

Return values

ta_c_rc_ok	Object instance written to loyalty_information.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	loyalty_information is null-pointer.

ta_card_data_get_pos_entry_mode()

ta_e_result_code_t ta_card_data_get_pos_entry_mode	(	ta_object_t	card_data,
		ta_e_pos_entry_mode_t *	pos_entry_mode
	)

POS entry mode.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	pos_entry_mode	Pointer to variable to write value to. Value is ta_c_pem_undefined if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to pos_entry_mode.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	pos_entry_mode is null-pointer.

ta_card_data_get_processing_disposition()

ta_e_result_code_t ta_card_data_get_processing_disposition	(	ta_object_t	card_data,
		ta_e_processing_disposition_t *	processing_disposition
	)

Petrol: Defines if the ECR or EFT is responsible for further trx handling.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	processing_disposition	Pointer to variable to write value to. Value is ta_c_pd_undefined if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to processing_disposition.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	processing_disposition is null-pointer.

ta_card_data_get_tender_name()

ta_e_result_code_t ta_card_data_get_tender_name	(	ta_object_t	card_data,
		ta_object_t *	tender_name
	)

Card tender name.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	tender_name	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to tender_name.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	tender_name is null-pointer.

ta_card_data_get_terminal_country_code()

ta_e_result_code_t ta_card_data_get_terminal_country_code	(	ta_object_t	card_data,
		ta_object_t *	country_code
	)

Terminal country code.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	country_code	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to country_code.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	country_code is null-pointer.

ta_card_data_get_token_pan()

ta_e_result_code_t ta_card_data_get_token_pan	(	ta_object_t	card_data,
		ta_object_t *	token_pan
	)

Token PAN.

The token PAN is a tokenized version for an underlaying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host.

The TokenPan field is used in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR.

The TokenPan field always must be accompanied by a corresponding TokenPanType field.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	token_pan	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to asrpd.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	token_pan is null-pointer.

ta_card_data_get_token_pan_type()

ta_e_result_code_t ta_card_data_get_token_pan_type	(	ta_object_t	card_data,
		ta_e_token_pan_type_t *	token_pan_type
	)

Token PAN type.

To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.

The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	token_pan_type	Pointer to variable to write object instance to.

Return values

ta_c_rc_ok	Object instance written to card_product_type.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	token_pan_type is null-pointer.

ta_card_data_get_uid()

ta_e_result_code_t ta_card_data_get_uid	(	ta_object_t	card_data,
		ta_object_t *	uid
	)

Uid of the contactless card.

Parameters

[in]	card_data	Object instance of type card_data.
[out]	uid	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in card_data.

Return values

ta_c_rc_ok	Object instance written to uid.
ta_c_rc_invalid_argument	card_data is ta_object_invalid.
ta_c_rc_invalid_argument	card_data is not of type card_data.
ta_c_rc_invalid_argument	uid is null-pointer.