TIM SDK
TIM API C
terminal_status.h File Reference

Description

Terminal status.

Object type terminal_status.

Functions

ta_e_result_code_t ta_terminal_status_get_display_content (ta_object_t terminal_status, ta_object_t *display_content)
 Content of display on EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_connection_status (ta_object_t terminal_status, ta_e_connection_status_t *connection_status)
 Connection status of the EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_management_status (ta_object_t terminal_status, ta_e_management_status_t *management_status)
 Management status of the EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_card_reader_status (ta_object_t terminal_status, ta_e_card_reader_status_t *card_reader_status)
 Status of card reader attached to EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_transaction_status (ta_object_t terminal_status, ta_e_transaction_status_t *transaction_status)
 Transaction status of EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_sleep_mode_status (ta_object_t terminal_status, ta_e_sleep_mode_status_t *sleep_mode_status)
 Sleep mode status of EFT Terminal. More...
 
ta_e_result_code_t ta_terminal_status_get_receipt_information (ta_object_t terminal_status, ta_e_boolean_t *receipt_information)
 Receipts can be retrieved. More...
 
ta_e_result_code_t ta_terminal_status_get_card_data (ta_object_t terminal_status, ta_object_t *card_data)
 Information about payment card used by the customer if present. More...
 
ta_e_result_code_t ta_terminal_status_get_sw_update_available (ta_object_t terminal_status, ta_e_boolean_t *sw_update_available)
 Software update is available. More...
 
ta_e_result_code_t ta_terminal_status_get_final_amount (ta_object_t terminal_status, ta_object_t *amount)
 If the amount of the original transaction has been adjusted. More...
 

Function Documentation

◆ ta_terminal_status_get_card_data()

ta_e_result_code_t ta_terminal_status_get_card_data ( ta_object_t  terminal_status,
ta_object_t card_data 
)

Information about payment card used by the customer if present.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]card_dataPointer to variable to write object instance to. Object instance is of type card_data and is not retained. Object instance is ta_object_invalid if value is not set in terminal_status.
Return values
ta_c_rc_okObject instance written to card_data.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentcard_data is null-pointer.

◆ ta_terminal_status_get_card_reader_status()

ta_e_result_code_t ta_terminal_status_get_card_reader_status ( ta_object_t  terminal_status,
ta_e_card_reader_status_t card_reader_status 
)

Status of card reader attached to EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]card_reader_statusPointer to variable to write value to.
Return values
ta_c_rc_okValue written to card_reader_status.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentcard_reader_status is null-pointer.

◆ ta_terminal_status_get_connection_status()

ta_e_result_code_t ta_terminal_status_get_connection_status ( ta_object_t  terminal_status,
ta_e_connection_status_t connection_status 
)

Connection status of the EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]connection_statusPointer to variable to write value to.
Return values
ta_c_rc_okValue written to connection_status.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentconnection_status is null-pointer.

◆ ta_terminal_status_get_display_content()

ta_e_result_code_t ta_terminal_status_get_display_content ( ta_object_t  terminal_status,
ta_object_t display_content 
)

Content of display on EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]display_contentPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type string.
Return values
ta_c_rc_okObject instance written to display_content.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentdisplay_content is null-pointer.

◆ ta_terminal_status_get_final_amount()

ta_e_result_code_t ta_terminal_status_get_final_amount ( ta_object_t  terminal_status,
ta_object_t amount 
)

If the amount of the original transaction has been adjusted.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]amountPointer to variable to write object instance to. Object instance is of type amount_final and is not retained. Object instance is ta_object_invalid if value is not set in terminal_status.
Return values
ta_c_rc_okObject instance written to card_data.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentamount is null-pointer.

◆ ta_terminal_status_get_management_status()

ta_e_result_code_t ta_terminal_status_get_management_status ( ta_object_t  terminal_status,
ta_e_management_status_t management_status 
)

Management status of the EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]management_statusPointer to variable to write value to.
Return values
ta_c_rc_okValue written to management_status.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentmanagement_status is null-pointer.

◆ ta_terminal_status_get_receipt_information()

ta_e_result_code_t ta_terminal_status_get_receipt_information ( ta_object_t  terminal_status,
ta_e_boolean_t receipt_information 
)

Receipts can be retrieved.

Use ta_terminal_receipt_request or ta_terminal_receipt_request_async.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]receipt_informationPointer to variable to write value to. Value is ta_c_b_undefined if value is not set in terminal_status.
Return values
ta_c_rc_okValue written to receipt_information.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentreceipt_information is null-pointer.

◆ ta_terminal_status_get_sleep_mode_status()

ta_e_result_code_t ta_terminal_status_get_sleep_mode_status ( ta_object_t  terminal_status,
ta_e_sleep_mode_status_t sleep_mode_status 
)

Sleep mode status of EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]sleep_mode_statusPointer to variable to write value to. Value is ta_c_sms_undefined if value is not set in terminal_status.
Return values
ta_c_rc_okValue written to sleep_mode_status.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentsleep_mode_status is null-pointer.

◆ ta_terminal_status_get_sw_update_available()

ta_e_result_code_t ta_terminal_status_get_sw_update_available ( ta_object_t  terminal_status,
ta_e_boolean_t sw_update_available 
)

Software update is available.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]sw_update_availablePointer to variable to write value to. Value is ta_c_b_undefined if value is not set in terminal_status.
Return values
ta_c_rc_okValue written to sw_update_available.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumentsw_update_available is null-pointer.

◆ ta_terminal_status_get_transaction_status()

ta_e_result_code_t ta_terminal_status_get_transaction_status ( ta_object_t  terminal_status,
ta_e_transaction_status_t transaction_status 
)

Transaction status of EFT Terminal.

Parameters
[in]terminal_statusObject instance of type terminal_status.
[out]transaction_statusPointer to variable to write value to.
Return values
ta_c_rc_okValue written to transaction_status.
ta_c_rc_invalid_argumentterminal_status is ta_object_invalid.
ta_c_rc_invalid_argumentterminal_status is not of type terminal_status.
ta_c_rc_invalid_argumenttransaction_status is null-pointer.