TIM SDK
TIM API C
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...
 

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_dataObject instance of type card_data.
[out]accPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to acc.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentacc 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_dataObject instance of type card_data.
[out]aidPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to aid.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentaid 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_dataObject instance of type card_data.
[out]asrpdPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to asrpd.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentasrpd 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_dataObject instance of type card_data.
[out]brand_namePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to brand_name.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentbrand_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_dataObject instance of type card_data.
[out]country_codePointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to country_code.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcountry_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_dataObject instance of type card_data.
[out]card_expiry_datePointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_expiry_date.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_numberPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_number.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_number_encPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_number_enc.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_number_enc_key_indexPointer to variable to write value to. Value is 0 if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_number_enc_key_index.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_number_printablePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_number_printable.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_number_printable_cardholderPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_number_printable_cardholder.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_product_typePointer to variable to write object instance to.
Return values
ta_c_rc_okObject instance written to card_product_type.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_refPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to card_ref.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_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_dataObject instance of type card_data.
[out]card_track_datasPointer 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_okObject instance written to card_track_datas.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcard_track_datas 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_dataObject instance of type card_data.
[out]languagePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to language.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentlanguage 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_dataObject instance of type card_data.
[out]loyalty_informationPointer 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_okObject instance written to loyalty_information.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentloyalty_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_dataObject instance of type card_data.
[out]pos_entry_modePointer 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_okObject instance written to pos_entry_mode.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentpos_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_dataObject instance of type card_data.
[out]processing_dispositionPointer 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_okObject instance written to processing_disposition.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentprocessing_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_dataObject instance of type card_data.
[out]tender_namePointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to tender_name.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumenttender_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_dataObject instance of type card_data.
[out]country_codePointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to country_code.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentcountry_code 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_dataObject instance of type card_data.
[out]uidPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in card_data.
Return values
ta_c_rc_okObject instance written to uid.
ta_c_rc_invalid_argumentcard_data is ta_invalid_object.
ta_c_rc_invalid_argumentcard_data is not of type card_data.
ta_c_rc_invalid_argumentuid is null-pointer.