Description

Terminal.

Object type terminal.

Note: In contrary to other object types getter functions for the object type terminal retains object instances returned to the caller.; Once a terminal object instance has been disposed all future function calls will fail with error ta_c_rc_invalid_argument.; Terminal object instances operate using internal multi-threading structures. Always call setter and action functions on the terminal object instances from the main application thread. Never call these functions from inside terminal_listener callbacks. If you need to call such functions in response to terminal events you have to delay the function calls to be issued on the main thread. Main thread in this context means the one and only thread issuing these kinds of function calls. Getter functions on the other hand can be used during terminal_listener callbacks.

Functions
const char *	ta_terminal_get_tim_api_version ()
	Tim Api Build Version.

ta_e_result_code_t	ta_terminal_create (ta_object_t *terminal, ta_object_t settings)
	Create terminal instance. More...

ta_e_result_code_t	ta_terminal_dispose (ta_object_t terminal)
	Dispose of terminal. More...

ta_e_result_code_t	ta_terminal_get_settings (ta_object_t terminal, ta_object_t *settings)
	Immutable terminal settings. More...

ta_e_result_code_t	ta_terminal_get_terminal_id (ta_object_t terminal, ta_object_t *terminal_id)
	Terminal identifier of connected terminal. More...

ta_e_result_code_t	ta_terminal_get_pos_id (ta_object_t terminal, ta_object_t *pos_id)
	POS identifier. More...

ta_e_result_code_t	ta_terminal_set_pos_id (ta_object_t terminal, ta_object_t pos_id)
	Set POS identifier. More...

ta_e_result_code_t	ta_terminal_get_user_id (ta_object_t terminal, int *user_id)
	User identifier. More...

ta_e_result_code_t	ta_terminal_set_user_id (ta_object_t terminal, int user_id)
	Set User identifier. More...

ta_e_result_code_t	ta_terminal_get_ecr_data (ta_object_t terminal, ta_object_t *ecr_data)
	ECR Data. More...

ta_e_result_code_t	ta_terminal_set_ecr_data (ta_object_t terminal, ta_object_t ecr_data)
	Set ECR Data. More...

ta_e_result_code_t	ta_terminal_add_ecr_data (ta_object_t terminal, ta_object_t ecr_info)
	Add ECR data replacing existing one if present. More...

ta_e_result_code_t	ta_terminal_get_allowed_third_party_apps (ta_object_t terminal, int *allowed_third_party_apps)
	Allowed third party apps. More...

ta_e_result_code_t	ta_terminal_set_allowed_third_party_apps (ta_object_t terminal, int allowed_third_party_apps)
	Set allowed third party apps. More...

ta_e_result_code_t	ta_terminal_get_print_options (ta_object_t terminal, ta_object_t *print_options)
	Print options. More...

ta_e_result_code_t	ta_terminal_set_print_options (ta_object_t terminal, ta_object_t print_options)
	Set Print options. More...

ta_e_result_code_t	ta_terminal_get_merchant_options (ta_object_t terminal, ta_object_t *merchant_options)
	Merchant options. More...

ta_e_result_code_t	ta_terminal_set_merchant_options (ta_object_t terminal, ta_object_t merchant_options)
	Set Merchant options. More...

ta_e_result_code_t	ta_terminal_get_customer_data (ta_object_t terminal, ta_object_t *customer_data)
	Customer data. More...

ta_e_result_code_t	ta_terminal_set_customer_data (ta_object_t terminal, ta_object_t customer_data)
	Set Customer data. More...

ta_e_result_code_t	ta_terminal_get_transaction_data (ta_object_t terminal, ta_object_t *transaction_data)
	Transaction data to use for transaction requests unless set manually. More...

ta_e_result_code_t	ta_terminal_set_transaction_data (ta_object_t terminal, ta_object_t transaction_data)
	Set transaction data to use for transaction requests unless set manually. More...

ta_e_result_code_t	ta_terminal_get_receipt_formatter (ta_object_t terminal, ta_object_t *formatter)
	Receipt formatter. More...

ta_e_result_code_t	ta_terminal_set_receipt_formatter (ta_object_t terminal, ta_object_t formatter)
	Set receipt formatter. More...

ta_e_result_code_t	ta_terminal_get_terminal_status (ta_object_t terminal, ta_object_t *terminal_status)
	Get terminal status. More...

ta_e_result_code_t	ta_terminal_get_brands (ta_object_t terminal, ta_object_t *brands)
	Get brands or 0 if not retrieved yet. More...

ta_e_result_code_t	ta_terminal_get_features (ta_object_t terminal, ta_s_features_t features, ta_e_boolean_t has_features)
	Get features if known. More...

ta_e_result_code_t	ta_terminal_get_supported_languages (ta_object_t terminal, ta_object_t *languages)
	Get supported languages or ta_object_invalid if unknown. More...

ta_e_result_code_t	ta_terminal_get_act_seq_counter (ta_object_t terminal, int *act_seq_counter)
	Activation sequence counter. More...

ta_e_result_code_t	ta_terminal_get_config_data (ta_object_t terminal, ta_object_t *config_data)
	Get configuration data. More...

ta_e_result_code_t	ta_terminal_get_license (ta_object_t terminal, ta_object_t *license)
	Supported licensed features as 8 bytes hex encoded bitmap. More...

ta_e_result_code_t	ta_terminal_activate (ta_object_t terminal, ta_object_t *response)
	Opens a user shift. More...

ta_e_result_code_t	ta_terminal_activate_async (ta_object_t terminal)
	Opens a user shift. More...

ta_e_result_code_t	ta_terminal_application_information (ta_object_t terminal)
	Requests the list of brands available on the terminal. More...

ta_e_result_code_t	ta_terminal_application_information_async (ta_object_t terminal)
	Requests the list of brands available on the terminal. More...

ta_e_result_code_t	ta_terminal_balance (ta_object_t terminal, ta_object_t *response)
	Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing. More...

ta_e_result_code_t	ta_terminal_balance_async (ta_object_t terminal)
	Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing. More...

ta_e_result_code_t	ta_terminal_cancel (ta_object_t terminal)
	Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled. More...

ta_e_result_code_t	ta_terminal_cancel2 (ta_object_t terminal, ta_e_boolean_t silent, ta_e_boolean_t retain_card)
	Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled. More...

ta_e_result_code_t	ta_terminal_change_settings (ta_object_t terminal, ta_object_t settings)
	Changes configuration parameters of the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_change_settings_async (ta_object_t terminal, ta_object_t settings)
	Changes configuration parameters of the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_commit (ta_object_t terminal)
	Performs Commit-operation after a successful Transaction call. More...

ta_e_result_code_t	ta_terminal_commit_async (ta_object_t terminal)
	Performs Commit-operation after a successful Transaction call. More...

ta_e_result_code_t	ta_terminal_commit_amount (ta_object_t terminal, ta_object_t amount, ta_object_t *response)
	Performs Commit-operation after a successful Transaction call. More...

ta_e_result_code_t	ta_terminal_commit_amount_async (ta_object_t terminal, ta_object_t amount)
	Performs Commit-operation after a successful Transaction call. More...

ta_e_result_code_t	ta_terminal_connect (ta_object_t terminal)
	Initiates a connection to the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_connect_async (ta_object_t terminal)
	Initiates a connection to the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_counter_request (ta_object_t terminal, ta_e_counter_type_t counter_type, ta_object_t *response)
	Get counter information's from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_counter_request_async (ta_object_t terminal, ta_e_counter_type_t counter_type)
	Get counter information's from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_deactivate (ta_object_t terminal, ta_object_t *response)
	Closes a user shift. More...

ta_e_result_code_t	ta_terminal_deactivate_async (ta_object_t terminal)
	Closes a user shift. More...

ta_e_result_code_t	ta_terminal_disconnect (ta_object_t terminal)
	Interrupts the connection to the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_disconnect_async (ta_object_t terminal)
	Interrupts the connection to the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_dcc_rates (ta_object_t terminal, ta_object_t *response)
	Requests DCC rates from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_dcc_rates_async (ta_object_t terminal)
	Requests DCC rates from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_hardware_information (ta_object_t terminal, ta_object_t *response)
	Get hardware information from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_hardware_information_async (ta_object_t terminal)
	Get hardware information from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_init_transaction (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_object_t *response)
	Initialize a transaction knowing the amount or the card type. More...

ta_e_result_code_t	ta_terminal_init_transaction2 (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_e_function_hint_t function_hint, ta_object_t *response)
	Initialize a transaction knowing the amount or the card type. More...

ta_e_result_code_t	ta_terminal_init_transaction_async (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount)
	Initialize a transaction knowing the amount or the card type. More...

ta_e_result_code_t	ta_terminal_init_transaction2_async (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_e_function_hint_t function_hint)
	Initialize a transaction knowing the amount or the card type. More...

ta_e_result_code_t	ta_terminal_client_identification (ta_object_t terminal, ta_object_t *response)
	Starts an EFT Client Identification. More...

ta_e_result_code_t	ta_terminal_client_identification_async (ta_object_t terminal)
	Starts an EFT Client Identification. More...

ta_e_result_code_t	ta_terminal_init_transaction_with_dialog (ta_object_t terminal, ta_object_t amount, ta_e_function_hint_t function_hint, ta_object_t dialog, ta_object_t *response)
	Initialize a transaction with dialog. More...

ta_e_result_code_t	ta_terminal_init_transaction_with_dialog_async (ta_object_t terminal, ta_object_t amount, ta_e_function_hint_t function_hint, ta_object_t dialog)
	Initialize a transaction with dialog. More...

ta_e_result_code_t	ta_terminal_login (ta_object_t terminal)
	Activate a communication session between the ECR and the terminal. More...

ta_e_result_code_t	ta_terminal_login_async (ta_object_t terminal)
	Activate a communication session between the ECR and the terminal. More...

ta_e_result_code_t	ta_terminal_logout (ta_object_t terminal)
	Terminates an active communication session between the ECR and the terminal. More...

ta_e_result_code_t	ta_terminal_logout_async (ta_object_t terminal)
	Terminates an active communication session between the ECR and the terminal. More...

ta_e_result_code_t	ta_terminal_reboot (ta_object_t terminal)
	Force the EFT Terminal to reboot. More...

ta_e_result_code_t	ta_terminal_reboot_async (ta_object_t terminal)
	Force the EFT Terminal to reboot. More...

ta_e_result_code_t	ta_terminal_reconciliation (ta_object_t terminal, ta_object_t *response)
	Force the EFT Terminal to transmit all financial transactions to the host system. More...

ta_e_result_code_t	ta_terminal_reconciliation_async (ta_object_t terminal)
	Force the EFT Terminal to transmit all financial transactions to the host system. More...

ta_e_result_code_t	ta_terminal_receipt_request (ta_object_t terminal, ta_e_receipt_request_type_t type, ta_object_t *response)
	Receive the latest receipt or a list of silent receipts. More...

ta_e_result_code_t	ta_terminal_receipt_request_async (ta_object_t terminal, ta_e_receipt_request_type_t type)
	Receive the latest receipt or a list of silent receipts. More...

ta_e_result_code_t	ta_terminal_transaction_info_request (ta_object_t terminal, ta_object_t *response)
	Receive the latest transaction information. More...

ta_e_result_code_t	ta_terminal_transaction_info_request_async (ta_object_t terminal)
	Receive the latest transaction information. More...

ta_e_result_code_t	ta_terminal_reconfig (ta_object_t terminal, ta_object_t *response)
	Force the EFT Terminal to get the configuration from the service center. More...

ta_e_result_code_t	ta_terminal_reconfig_async (ta_object_t terminal)
	Force the EFT Terminal to get the configuration from the service center. More...

ta_e_result_code_t	ta_terminal_rollback (ta_object_t terminal, ta_object_t *response)
	Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. More...

ta_e_result_code_t	ta_terminal_rollback_async (ta_object_t terminal)
	Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. More...

ta_e_result_code_t	ta_terminal_software_update (ta_object_t terminal, ta_e_update_status_t *response)
	Force the EFT Terminal to start a Software Update. More...

ta_e_result_code_t	ta_terminal_software_update_async (ta_object_t terminal)
	Force the EFT Terminal to start a Software Update. More...

ta_e_result_code_t	ta_terminal_system_information (ta_object_t terminal, ta_object_t *response)
	Request system information from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_system_information_async (ta_object_t terminal)
	Request system information from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_transaction (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t *response)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction2 (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t request, ta_object_t *response)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction2_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t request)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction_tip (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_tip, ta_object_t *response)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction_tip_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_tip)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction_cashback (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_cashback, ta_object_t *response)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_transaction_cashback_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_cashback)
	Starts an EFT Terminal Transaction. More...

ta_e_result_code_t	ta_terminal_close_reader (ta_object_t terminal)
	Close the shutter of the card reader. More...

ta_e_result_code_t	ta_terminal_close_reader_async (ta_object_t terminal)
	Close the shutter of the card reader. More...

ta_e_result_code_t	ta_terminal_open_reader (ta_object_t terminal)
	Open the shutter of the card reader. More...

ta_e_result_code_t	ta_terminal_open_reader_async (ta_object_t terminal)
	Open the shutter of the card reader. More...

ta_e_result_code_t	ta_terminal_eject_card (ta_object_t terminal)
	Eject a card from the card reader. More...

ta_e_result_code_t	ta_terminal_eject_card_async (ta_object_t terminal)
	Eject a card from the card reader. More...

ta_e_result_code_t	ta_terminal_open_maintenance_window (ta_object_t terminal)
	Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More...

ta_e_result_code_t	ta_terminal_open_maintenance_window_async (ta_object_t terminal)
	Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More...

ta_e_result_code_t	ta_terminal_close_maintenance_window (ta_object_t terminal)
	Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More...

ta_e_result_code_t	ta_terminal_close_maintenance_window_async (ta_object_t terminal)
	Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More...

ta_e_result_code_t	ta_terminal_hold_commit (ta_object_t terminal)
	Extends the Commit timeout if the terminal needs additional time before the Commit shall be performed. More...

ta_e_result_code_t	ta_terminal_activate_service_menu (ta_object_t terminal)
	Activate service menu. More...

ta_e_result_code_t	ta_terminal_activate_service_menu_async (ta_object_t terminal)
	Activate service menu. More...

ta_e_result_code_t	ta_terminal_amt_adjustment (ta_object_t terminal, ta_object_t amount)
	Dynamically adjusts the transaction amount of an already running transaction. More...

ta_e_result_code_t	ta_terminal_amt_adjustment_2 (ta_object_t terminal, ta_object_t amount, ta_object_t amount_discount, ta_object_t loyalty_coupon_list, ta_object_t loyalty_information_list)
	Dynamically adjusts the transaction amount of an already running transaction. More...

ta_e_result_code_t	ta_terminal_loyalty_data (ta_object_t terminal, ta_e_loyalty_function_type_t function_type, ta_object_t data_type, ta_object_t data, ta_e_boolean_t retain_card, ta_object_t *response)
	This function is used to query and configure loyalty information. More...

ta_e_result_code_t	ta_terminal_loyalty_data_async (ta_object_t terminal, ta_e_loyalty_function_type_t function_type, ta_object_t data_type, ta_object_t data, ta_e_boolean_t retain_card)
	This function is used to query and configure loyalty information. More...

ta_e_result_code_t	ta_terminal_start_checkout (ta_object_t terminal)
	This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started. More...

ta_e_result_code_t	ta_terminal_start_checkout_async (ta_object_t terminal)
	This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started. More...

ta_e_result_code_t	ta_terminal_finish_checkout (ta_object_t terminal, ta_object_t *response)
	This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process. More...

ta_e_result_code_t	ta_terminal_finish_checkout_async (ta_object_t terminal)
	This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process. More...

ta_e_result_code_t	ta_terminal_provide_loyalty_basket (ta_object_t terminal, ta_object_t basket, ta_object_t *response)
	This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More...

ta_e_result_code_t	ta_terminal_provide_loyalty_basket_async (ta_object_t terminal, ta_object_t basket)
	This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More...

ta_e_result_code_t	ta_terminal_provide_vas_result (ta_object_t terminal, ta_object_t result, ta_object_t *response)
	This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More...

ta_e_result_code_t	ta_terminal_provide_vas_result_async (ta_object_t terminal, ta_object_t result)
	This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More...

ta_e_result_code_t	ta_terminal_mobile_topup_issuer_info (ta_object_t terminal, ta_object_t *response)
	Request Mobile Topup Issuer information. More...

ta_e_result_code_t	ta_terminal_mobile_topup_issuer_info_async (ta_object_t terminal)
	Request Mobile Topup Issuer information. More...

ta_e_result_code_t	ta_terminal_mobile_topup (ta_object_t terminal, ta_e_mobile_topup_type_t type, ta_object_t issuer_name, ta_object_t amount, ta_object_t *response)
	Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL. More...

ta_e_result_code_t	ta_terminal_mobile_topup2 (ta_object_t terminal, ta_e_mobile_topup_type_t type, ta_object_t value, ta_object_t *response)
	Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL. More...

ta_e_result_code_t	ta_terminal_mobile_topup_async (ta_object_t terminal, ta_e_mobile_topup_type_t type, ta_object_t issuer_name, ta_object_t amount)
	Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL. More...

ta_e_result_code_t	ta_terminal_mobile_topup2_async (ta_object_t terminal, ta_e_mobile_topup_type_t type, ta_object_t value)
	Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL. More...

ta_e_result_code_t	ta_terminal_open_dialog_mode (ta_object_t terminal)
	Open dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_open_dialog_mode2 (ta_object_t terminal, ta_e_boolean_t silent)
	Open dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_open_dialog_mode_async (ta_object_t terminal)
	Open dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_open_dialog_mode2_async (ta_object_t terminal, ta_e_boolean_t silent)
	Open dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_close_dialog_mode (ta_object_t terminal)
	Close dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_close_dialog_mode_async (ta_object_t terminal)
	Close dialog mode on the terminal. More...

ta_e_result_code_t	ta_terminal_show_signature_capture (ta_object_t terminal, ta_object_t request, ta_object_t *response)
	Show signature capture on the terminal. More...

ta_e_result_code_t	ta_terminal_show_signature_capture_async (ta_object_t terminal, ta_object_t request)
	Request system information from the EFT Terminal. More...

ta_e_result_code_t	ta_terminal_show_dialog (ta_object_t terminal, ta_object_t request, ta_object_t *response)
	Show dialog on the terminal. More...

ta_e_result_code_t	ta_terminal_show_dialog_async (ta_object_t terminal, ta_object_t request)
	Show dialog on the terminal. More...

ta_e_result_code_t	ta_terminal_print_on_terminal (ta_object_t terminal, ta_object_t ticket_data)
	The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. More...

ta_e_result_code_t	ta_terminal_print_on_terminal_async (ta_object_t terminal, ta_object_t ticket_data)
	The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. More...

ta_e_result_code_t	ta_terminal_send_card_command (ta_object_t terminal, ta_object_t requests, ta_object_t *responses)
	Send card command. More...

ta_e_result_code_t	ta_terminal_send_card_command_async (ta_object_t terminal, ta_object_t requests)
	Send card command. More...

ta_e_result_code_t	ta_terminal_balance_inquiry (ta_object_t terminal, ta_object_t *response)
	Get information about the current account balance of the inserted card. More...

ta_e_result_code_t	ta_terminal_balance_inquiry_async (ta_object_t terminal)
	Get information about the current account balance of the inserted card. More...

ta_e_result_code_t	ta_terminal_request_alias (ta_object_t terminal, ta_object_t six_trans_ref, ta_object_t *response)
	The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions. More...

ta_e_result_code_t	ta_terminal_request_alias_async (ta_object_t terminal, ta_object_t six_trans_ref)
	The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions. More...

ta_e_result_code_t	ta_terminal_device_maintenance (ta_object_t terminal, ta_e_maintenance_type_t type)
	Perform device maintenance. More...

ta_e_result_code_t	ta_terminal_device_maintenance_async (ta_object_t terminal, ta_e_maintenance_type_t type)
	Perform device maintenance. More...

ta_e_result_code_t	ta_terminal_screenshot (ta_object_t terminal)
	Send notification to request EFT make a screenshot. More...

ta_e_result_code_t	ta_terminal_third_party_app_data (ta_object_t terminal, ta_object_t data)
	Send third_party_app_data to request EFT make a screenshot. More...

ta_e_result_code_t	ta_terminal_change_language_for_request (ta_object_t terminal, ta_object_t language)
	Change the cardholder language for the duration of the current process / open request. More...

ta_e_result_code_t	ta_terminal_can_dcc (ta_object_t terminal, ta_e_boolean_t *result)
	Returns true if at least one payment protocol and the terminal configuration offer DCC i.e. if there is a chance to do a DCC transaction. More...

ta_e_result_code_t	ta_terminal_can_declined_receipts (ta_object_t terminal, ta_e_boolean_t *result)
	Support for "Declined Receipts" in at least one payment protocol. More...

ta_e_result_code_t	ta_terminal_can_multi_account_selection (ta_object_t terminal, ta_e_boolean_t *result)
	Support for multiple account selection. More...

ta_e_result_code_t	ta_terminal_has_sw_update (ta_object_t terminal, ta_e_boolean_t *result)
	Software update is available. More...

ta_e_result_code_t	ta_terminal_get_item_textcode (ta_object_t terminal, int item_text_code, ta_e_additional_info_item_t *result)
	Convert item text code to AdditionalInfoItem value. More...

ta_e_result_code_t	ta_terminal_get_item_textcode_description (ta_object_t terminal, ta_e_additional_info_item_t item, const char **result)
	Get text description of AdditionalInfoItem. More...

ta_e_result_code_t	ta_terminal_add_listener (ta_object_t terminal, ta_object_t listener)
	Register listener. More...

ta_e_result_code_t	ta_terminal_remove_listener (ta_object_t terminal, ta_object_t listener)
	Unregister listener. More...

ta_e_result_code_t	ta_terminal_set_custom_logger (ta_object_t terminal, ta_cb_publish_log_record callback, void *user_pointer)
	Set custom terminal logger callback. More...

Function Documentation

◆ ta_terminal_activate()

ta_e_result_code_t ta_terminal_activate	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Opens a user shift.

If the shift is already open, no error is returned.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type activate_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_activate_async()

ta_e_result_code_t ta_terminal_activate_async ( ta_object_t terminal )

Opens a user shift.

If the shift is already open, no error is returned.

Asynchronous version of ta_terminal_activate. Callback function is ta_cb_terminal_activate_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request send successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_activate_service_menu()

ta_e_result_code_t ta_terminal_activate_service_menu ( ta_object_t terminal )

Activate service menu.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_activate_service_menu_async()

ta_e_result_code_t ta_terminal_activate_service_menu_async ( ta_object_t terminal )

Activate service menu.

Asynchronous version of ta_terminal_activate_service_menu. Callback function is ta_cb_terminal_activate_service_menu_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_add_ecr_data()

ta_e_result_code_t ta_terminal_add_ecr_data	(	ta_object_t	terminal,
		ta_object_t	ecr_info
	)

Add ECR data replacing existing one if present.

To remove elements use ta_terminal_set_ecr_data instead.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	ecr_info	Object instance to add. Object instance has to be of type ecr_info.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	ecr_info is ta_object_invalid.
ta_c_rc_invalid_argument	ecr_info is not of type ecr_info.

◆ ta_terminal_add_listener()

ta_e_result_code_t ta_terminal_add_listener	(	ta_object_t	terminal,
		ta_object_t	listener
	)

Register listener.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	listener	Object instance of type terminal_listener.

Return values

ta_c_rc_ok	Listener added to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	listener is ta_object_invalid.

◆ ta_terminal_amt_adjustment()

ta_e_result_code_t ta_terminal_amt_adjustment	(	ta_object_t	terminal,
		ta_object_t	amount
	)

Dynamically adjusts the transaction amount of an already running transaction.

This is a "best effort" function and will be processed as long as the underlaying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.

To be able to validate if this notification has been processed correctly the TerminalStatus-notification must return the current adjusted Amount.

Note: This method is only available if guide unattended is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount.

Return values

ta_c_rc_ok	Hold commit send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount.

◆ ta_terminal_amt_adjustment_2()

ta_e_result_code_t ta_terminal_amt_adjustment_2	(	ta_object_t	terminal,
		ta_object_t	amount,
		ta_object_t	amount_discount,
		ta_object_t	loyalty_coupon_list,
		ta_object_t	loyalty_information_list
	)

Dynamically adjusts the transaction amount of an already running transaction.

This is a "best effort" function and will be processed as long as the underlaying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.

To be able to validate if this notification has been processed correctly the TerminalStatus-notification must return the current adjusted Amount.

Note: This method is only available if guide unattended is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount.
[in]	amount_discount	Optional discount amount. If not ta_object_invalid object instance has to be of type amount_discount.
[in]	loyalty_coupon_list	Optional list of loyalty coupons. If not ta_object_invalid object instance has to be of type list with elements inside have to be of type loyalty_coupon.
[in]	loyalty_information_list	Optional list of loyalty information. If not ta_object_invalid object instance has to be of type list with elements inside have to be of type loyalty_information.

Return values

ta_c_rc_ok	Hold commit send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount is not of type amount.
ta_c_rc_invalid_argument	amount_discount is not ta_object_invalid and is not of type amount_discount.
ta_c_rc_invalid_argument	loyalty_coupon_list is not ta_object_invalid and not of type list.
ta_c_rc_invalid_argument	Elements in loyalty_coupon_list are ta_object_invalid.
ta_c_rc_invalid_argument	Elements in loyalty_coupon_list are not of type loyalty_coupon.
ta_c_rc_invalid_argument	loyalty_information_list is not ta_object_invalid and not of type list.
ta_c_rc_invalid_argument	Elements in loyalty_information_list are ta_object_invalid.
ta_c_rc_invalid_argument	Elements in loyalty_information_list are not of type loyalty_information.

◆ ta_terminal_application_information()

ta_e_result_code_t ta_terminal_application_information ( ta_object_t terminal )

Requests the list of brands available on the terminal.

Side-Effect:: Updates Brands member with all brands available on the terminal. Use ta_terminal_get_brands to retrieve them.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_application_information_async()

ta_e_result_code_t ta_terminal_application_information_async ( ta_object_t terminal )

Requests the list of brands available on the terminal.

Asynchronous version of ta_terminal_application_information. Callback function is ta_cb_terminal_application_information_completed.

Side-Effect:: Updates Brands member with all brands available on the terminal. Use ta_terminal_get_brands to retrieve them.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request send successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_balance()

ta_e_result_code_t ta_terminal_balance	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type balance_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_balance_async()

ta_e_result_code_t ta_terminal_balance_async ( ta_object_t terminal )

Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.

Asynchronous version of ta_terminal_balance. Callback function is ta_cb_terminal_balance_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request send successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_balance_inquiry()

ta_e_result_code_t ta_terminal_balance_inquiry	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Get information about the current account balance of the inserted card.

Note: This method is only available if guide advanced_retail is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type balance_inquiry_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_balance_inquiry_async()

ta_e_result_code_t ta_terminal_balance_inquiry_async ( ta_object_t terminal )

Get information about the current account balance of the inserted card.

Asynchronous version of ta_terminal_balance_inquiry. Callback function is ta_cb_terminal_balance_inquiry_completed.

Note: This method is only available if guide advanced_retail is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_can_dcc()

ta_e_result_code_t ta_terminal_can_dcc	(	ta_object_t	terminal,
		ta_e_boolean_t *	result
	)

Returns true if at least one payment protocol and the terminal configuration offer DCC i.e. if there is a chance to do a DCC transaction.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	result	Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_can_declined_receipts()

ta_e_result_code_t ta_terminal_can_declined_receipts	(	ta_object_t	terminal,
		ta_e_boolean_t *	result
	)

Support for "Declined Receipts" in at least one payment protocol.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	result	Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_can_multi_account_selection()

ta_e_result_code_t ta_terminal_can_multi_account_selection	(	ta_object_t	terminal,
		ta_e_boolean_t *	result
	)

Support for multiple account selection.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	result	Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_cancel()

ta_e_result_code_t ta_terminal_cancel ( ta_object_t terminal )

Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled.

Further information: A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be cancelled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the cancelled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.

The Transaction request can only be cancelled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Cancel send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_cancel2()

ta_e_result_code_t ta_terminal_cancel2	(	ta_object_t	terminal,
		ta_e_boolean_t	silent,
		ta_e_boolean_t	retain_card
	)

Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled.

Further information: A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be cancelled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the cancelled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.

The Transaction request can only be cancelled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	silent	ta_c_b_true to not show an abort screen otherwise ta_c_b_false.
[in]	retain_card	ta_c_b_true to not eject card otherwise ta_c_b_false.

Return values

ta_c_rc_ok	Cancel send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_change_language_for_request()

ta_e_result_code_t ta_terminal_change_language_for_request	(	ta_object_t	terminal,
		ta_object_t	language
	)

Change the cardholder language for the duration of the current process / open request.

The language is set back to standard after the current request returns. Following interactions need to set the language again. For the main use case in focus, InitTransaction, this means that the language of the InitTransaction idle screen is changed until the InitTransaction finished event occurs. The last screen set by the process is not changed back to the default language.

This is a "best effort" function.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	language	Object instance of type string.

Return values

ta_c_rc_ok	Hold commit send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	language is ta_object_invalid.
ta_c_rc_invalid_argument	language is not of type string.

◆ ta_terminal_change_settings()

ta_e_result_code_t ta_terminal_change_settings	(	ta_object_t	terminal,
		ta_object_t	settings
	)

Changes configuration parameters of the EFT Terminal.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	settings	Object instance with settings. Object instance has to be of type map. Keys in the map have to be of type integer matching ta_e_setting_type_t. Values in the map have to be of type string.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	settings is ta_object_invalid.
ta_c_rc_invalid_argument	settings is not of type map.
ta_c_rc_invalid_argument	Key in settings is ta_object_invalid.
ta_c_rc_invalid_argument	Key in settings is not of type integer.
ta_c_rc_invalid_argument	Value in settings is ta_object_invalid.
ta_c_rc_invalid_argument	Value in settings is not of type string.

◆ ta_terminal_change_settings_async()

ta_e_result_code_t ta_terminal_change_settings_async	(	ta_object_t	terminal,
		ta_object_t	settings
	)

Changes configuration parameters of the EFT Terminal.

Asynchronous version of ta_terminal_change_settings. Callback function is ta_cb_terminal_change_settings_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	settings	Object instance with settings. Object instance has to be of type map. Keys in the map have to be of type integer matching ta_e_setting_type_t. Values in the map have to be of type string.

Return values

ta_c_rc_ok	Request send successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	settings is ta_object_invalid.
ta_c_rc_invalid_argument	settings is not of type map.
ta_c_rc_invalid_argument	Key in settings is ta_object_invalid.
ta_c_rc_invalid_argument	Key in settings is not of type integer.
ta_c_rc_invalid_argument	Value in settings is ta_object_invalid.
ta_c_rc_invalid_argument	Value in settings is not of type string.

◆ ta_terminal_client_identification()

ta_e_result_code_t ta_terminal_client_identification	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Starts an EFT Client Identification.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in the response. Otherwise object instance is of type client_identification_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. If object instance is not ta_object_invalid object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_client_identification_async()

ta_e_result_code_t ta_terminal_client_identification_async ( ta_object_t terminal )

Starts an EFT Client Identification.

Asynchronous version of ta_terminal_client_identification. Callback function is ta_cb_terminal_client_identification_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_dialog_mode()

ta_e_result_code_t ta_terminal_close_dialog_mode ( ta_object_t terminal )

Close dialog mode on the terminal.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_dialog_mode_async()

ta_e_result_code_t ta_terminal_close_dialog_mode_async ( ta_object_t terminal )

Close dialog mode on the terminal.

Asynchronous version of ta_terminal_close_dialog_mode. Callback function is ta_cb_terminal_close_dialog_mode_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_maintenance_window()

ta_e_result_code_t ta_terminal_close_maintenance_window ( ta_object_t terminal )

Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.

The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.

If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.

It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_maintenance_window_async()

ta_e_result_code_t ta_terminal_close_maintenance_window_async ( ta_object_t terminal )

Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.

The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.

If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.

It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.

Asynchronous version of ta_terminal_close_maintenance_window. Callback function is ta_cb_terminal_close_maintenance_window_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_reader()

ta_e_result_code_t ta_terminal_close_reader ( ta_object_t terminal )

Close the shutter of the card reader.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_close_reader_async()

ta_e_result_code_t ta_terminal_close_reader_async ( ta_object_t terminal )

Close the shutter of the card reader.

Asynchronous version of ta_terminal_close_reader. Callback function is ta_cb_terminal_close_reader_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_commit()

ta_e_result_code_t ta_terminal_commit ( ta_object_t terminal )

Performs Commit-operation after a successful Transaction call.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_commit_amount()

ta_e_result_code_t ta_terminal_commit_amount	(	ta_object_t	terminal,
		ta_object_t	amount,
		ta_object_t *	response
	)

Performs Commit-operation after a successful Transaction call.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount or ta_object_invalid.
[out]	response	Pointer to write object instance of type print_data.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and object instance is not of type amount.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_commit_amount_async()

ta_e_result_code_t ta_terminal_commit_amount_async	(	ta_object_t	terminal,
		ta_object_t	amount
	)

Performs Commit-operation after a successful Transaction call.

Asynchronous version of ta_terminal_commit. Callback function is ta_cb_terminal_commit_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount or ta_object_invalid.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and object instance is not of type amount.

◆ ta_terminal_commit_async()

ta_e_result_code_t ta_terminal_commit_async ( ta_object_t terminal )

Performs Commit-operation after a successful Transaction call.

Asynchronous version of ta_terminal_commit. Callback function is ta_cb_terminal_commit_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_connect()

ta_e_result_code_t ta_terminal_connect ( ta_object_t terminal )

Initiates a connection to the EFT Terminal.

Calling this function is not needed normally, because all methods make first a connect, if not connected

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Connected to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_connect_async()

ta_e_result_code_t ta_terminal_connect_async ( ta_object_t terminal )

Initiates a connection to the EFT Terminal.

Calling this function is not needed normally, because all methods make first a connect, if not connected

Asynchronous version of ta_terminal_connect. Callback function is ta_cb_terminal_connect_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Started connecting to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_counter_request()

ta_e_result_code_t ta_terminal_counter_request	(	ta_object_t	terminal,
		ta_e_counter_type_t	counter_type,
		ta_object_t *	response
	)

Get counter information's from the EFT Terminal.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	counter_type	Type of counters to receive.
[out]	response	Pointer to variable to write object instance to. Object instance is of type counters. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_counter_request_async()

ta_e_result_code_t ta_terminal_counter_request_async	(	ta_object_t	terminal,
		ta_e_counter_type_t	counter_type
	)

Get counter information's from the EFT Terminal.

Asynchronous version of ta_terminal_counter_request. Callback function is ta_cb_terminal_counter_request_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	counter_type	Type of counters to receive.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_create()

ta_e_result_code_t ta_terminal_create	(	ta_object_t *	terminal,
		ta_object_t	settings
	)

Create terminal instance.

Caller retains a reference to the created instance. Different users can individually retain the terminal instance themselves by calling ta_object_retain. Each call to ta_object_retain and ta_terminal_create has to be matched with a call to ta_object_release. The terminal instance is destroyed once nobody retains the terminal instance anymore.

The provided terminal settings instance is not change nor stored. Instead an immutable copy thereof is stored.

Parameters

[out]	terminal	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	settings	Object instance of type terminal_settings. Terminal object stores an internal read-only copy of the terminal settings. It is safe to change the object instance after this call without affecting the terminal object.

Return values

ta_c_rc_ok	Object instance has been created and written to terminal.
ta_c_rc_invalid_argument	terminal is null-pointer.
ta_c_rc_invalid_argument	settings is ta_object_invalid.
ta_c_rc_out_of_memory	Failed allocating memory.

◆ ta_terminal_dcc_rates()

ta_e_result_code_t ta_terminal_dcc_rates	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Requests DCC rates from the EFT Terminal.

The DCC rates are returned as receipt.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type print_data. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_dcc_rates_async()

ta_e_result_code_t ta_terminal_dcc_rates_async ( ta_object_t terminal )

Requests DCC rates from the EFT Terminal.

The DCC rates are returned as receipt.

Asynchronous version of ta_terminal_dcc_rates. Callback function is ta_cb_terminal_dcc_rates_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_deactivate()

ta_e_result_code_t ta_terminal_deactivate	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Closes a user shift.

If the shift is already closed, no error is returned.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type deactivate_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_deactivate_async()

ta_e_result_code_t ta_terminal_deactivate_async ( ta_object_t terminal )

Closes a user shift.

If the shift is already closed, no error is returned.

Asynchronous version of ta_terminal_deactivate. Callback function is ta_cb_terminal_deactivate_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_device_maintenance()

ta_e_result_code_t ta_terminal_device_maintenance	(	ta_object_t	terminal,
		ta_e_maintenance_type_t	type
	)

Perform device maintenance.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Type of maintenance to perform.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_device_maintenance_async()

ta_e_result_code_t ta_terminal_device_maintenance_async	(	ta_object_t	terminal,
		ta_e_maintenance_type_t	type
	)

Perform device maintenance.

Asynchronous version of ta_terminal_device_maintenance. Callback function is ta_cb_terminal_device_maintenance_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Type of maintenance to perform.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_disconnect()

ta_e_result_code_t ta_terminal_disconnect ( ta_object_t terminal )

Interrupts the connection to the EFT Terminal.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Disconnected from terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_disconnect_async()

ta_e_result_code_t ta_terminal_disconnect_async ( ta_object_t terminal )

Interrupts the connection to the EFT Terminal.

Asynchronous version of ta_terminal_disconnect. Callback function is ta_cb_terminal_disconnected.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Started disconnecting from terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_dispose()

ta_e_result_code_t ta_terminal_dispose ( ta_object_t terminal )

Dispose of terminal.

Once disposed all terminal functionality returns ta_c_rc_invalid_argument if called.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Terminal has been disposed.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_eject_card()

ta_e_result_code_t ta_terminal_eject_card ( ta_object_t terminal )

Eject a card from the card reader.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_eject_card_async()

ta_e_result_code_t ta_terminal_eject_card_async ( ta_object_t terminal )

Eject a card from the card reader.

Asynchronous version of ta_terminal_eject_card. Callback function is ta_cb_terminal_eject_card_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_finish_checkout()

ta_e_result_code_t ta_terminal_finish_checkout	(	ta_object_t	terminal,
		ta_object_t *	response
	)

This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Variable to write object of type vas_checkout_information.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_finish_checkout_async()

ta_e_result_code_t ta_terminal_finish_checkout_async ( ta_object_t terminal )

This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process.

Asynchronous version of ta_terminal_finish_checkout. Callback function is ta_cb_terminal_finish_checkout_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_get_act_seq_counter()

ta_e_result_code_t ta_terminal_get_act_seq_counter	(	ta_object_t	terminal,
		int *	act_seq_counter
	)

Activation sequence counter.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	act_seq_counter	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to act_seq_counter.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	act_seq_counter is null-pointer.

◆ ta_terminal_get_allowed_third_party_apps()

ta_e_result_code_t ta_terminal_get_allowed_third_party_apps	(	ta_object_t	terminal,
		int *	allowed_third_party_apps
	)

Allowed third party apps.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	allowed_third_party_apps	OR combined flags from ta_e_allowed_third_party_apps_t.

Return values

ta_c_rc_ok	Object instance written to allowed_third_party_apps. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	allowed_third_party_apps is null-pointer.

◆ ta_terminal_get_brands()

ta_e_result_code_t ta_terminal_get_brands	(	ta_object_t	terminal,
		ta_object_t *	brands
	)

Get brands or 0 if not retrieved yet.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	brands	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. Otherwise object instance is of type list and object instance is retained. Elements in the list are of type brand.

Return values

ta_c_rc_ok	Object instance written to brands. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	brands is null-pointer.

◆ ta_terminal_get_config_data()

ta_e_result_code_t ta_terminal_get_config_data	(	ta_object_t	terminal,
		ta_object_t *	config_data
	)

Get configuration data.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	config_data	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. Otherwise object instance is of type config_data and object instance is retained.

Return values

ta_c_rc_ok	Object instance written to config_data. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	config_data is null-pointer.

◆ ta_terminal_get_customer_data()

ta_e_result_code_t ta_terminal_get_customer_data	(	ta_object_t	terminal,
		ta_object_t *	customer_data
	)

Customer data.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	customer_data	Pointer to variable to write object instance to. Object instance is of type map. Object instance is retained. Elements in the map are of key type integer containing values of enumeration ta_e_customer_data_type_t and value type string.

Return values

ta_c_rc_ok	Object instance written to customer_data. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	customer_data is null-pointer.

◆ ta_terminal_get_ecr_data()

ta_e_result_code_t ta_terminal_get_ecr_data	(	ta_object_t	terminal,
		ta_object_t *	ecr_data
	)

ECR Data.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	ecr_data	Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type ecr_info.

Return values

ta_c_rc_ok	Object instance written to ecr_data. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	ecr_data is null-pointer.

◆ ta_terminal_get_features()

ta_e_result_code_t ta_terminal_get_features	(	ta_object_t	terminal,
		ta_s_features_t *	features,
		ta_e_boolean_t *	has_features
	)

Get features if known.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	features	Pointer to variable to write values to if features are known. Pointer can be null-pointer if only feature presence is of interest.
[out]	has_features	Pointer to variable to write presence of features. Set to ta_c_b_true if features are present otherwise ta_c_b_false.

Return values

ta_c_rc_ok	Feature presence written to has_features. If has_features is ta_c_b_true values are also written to features.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	has_features is null-pointer.

◆ ta_terminal_get_item_textcode()

ta_e_result_code_t ta_terminal_get_item_textcode	(	ta_object_t	terminal,
		int	item_text_code,
		ta_e_additional_info_item_t *	result
	)

Convert item text code to AdditionalInfoItem value.

Parameters

[out] result Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_get_item_textcode_description()

ta_e_result_code_t ta_terminal_get_item_textcode_description	(	ta_object_t	terminal,
		ta_e_additional_info_item_t	item,
		const char **	result
	)

Get text description of AdditionalInfoItem.

Parameters

[out] result Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_get_license()

ta_e_result_code_t ta_terminal_get_license	(	ta_object_t	terminal,
		ta_object_t *	license
	)

Supported licensed features as 8 bytes hex encoded bitmap.

Deprecated:: Functionality removed.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	license	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. Otherwise object instance is of type string and object instance is retained.

Return values

ta_c_rc_ok	Object instance written to license. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	license is null-pointer.

◆ ta_terminal_get_merchant_options()

ta_e_result_code_t ta_terminal_get_merchant_options	(	ta_object_t	terminal,
		ta_object_t *	merchant_options
	)

Merchant options.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	merchant_options	Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type merchant_option.

Return values

ta_c_rc_ok	Object instance written to merchant_options. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	merchant_options is null-pointer.

◆ ta_terminal_get_pos_id()

ta_e_result_code_t ta_terminal_get_pos_id	(	ta_object_t	terminal,
		ta_object_t *	pos_id
	)

POS identifier.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	pos_id	Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained.

Return values

ta_c_rc_ok	Object instance written to pos_id. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	pos_id is null-pointer.

◆ ta_terminal_get_print_options()

ta_e_result_code_t ta_terminal_get_print_options	(	ta_object_t	terminal,
		ta_object_t *	print_options
	)

Print options.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	print_options	Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type print_option.

Return values

ta_c_rc_ok	Object instance written to print_options. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	print_options is null-pointer.

◆ ta_terminal_get_receipt_formatter()

ta_e_result_code_t ta_terminal_get_receipt_formatter	(	ta_object_t	terminal,
		ta_object_t *	formatter
	)

Receipt formatter.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	formatter	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. If object instance is not ta_object_invalid it is of type receipt_formatter and will be retained.

Return values

ta_c_rc_ok	Object instance written to formatter. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	formatter is null-pointer.

◆ ta_terminal_get_settings()

ta_e_result_code_t ta_terminal_get_settings	(	ta_object_t	terminal,
		ta_object_t *	settings
	)

Immutable terminal settings.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	settings	Pointer to variable to write object instance to. Object instance is of type terminal_settings. Object instance is retained.

Return values

ta_c_rc_ok	Object instance written to settings. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	settings is null-pointer.

◆ ta_terminal_get_supported_languages()

ta_e_result_code_t ta_terminal_get_supported_languages	(	ta_object_t	terminal,
		ta_object_t *	languages
	)

Get supported languages or ta_object_invalid if unknown.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	languages	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. Otherwise object instance is of type list and object instance is retained. Elements in the list are of type string.

Return values

ta_c_rc_ok	Object instance written to languages. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	languages is null-pointer.

◆ ta_terminal_get_terminal_id()

ta_e_result_code_t ta_terminal_get_terminal_id	(	ta_object_t	terminal,
		ta_object_t *	terminal_id
	)

Terminal identifier of connected terminal.

Returns ta_object_invalid if the terminal identifier is not known. The terminal identifier is available after logging in to the terminal. The terminal identifier obtained from the terminal is potentially different from the terminal identifier set in the terminal_settings. This is especially true if ta_c_cm_on_fix_ip is used.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	terminal_id	Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained.

Return values

ta_c_rc_ok	Object instance written to settings. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	terminal_id is null-pointer.

◆ ta_terminal_get_terminal_status()

ta_e_result_code_t ta_terminal_get_terminal_status	(	ta_object_t	terminal,
		ta_object_t *	terminal_status
	)

Get terminal status.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	terminal_status	Pointer to variable to write object instance to. Object instance is of type terminal_status. Object instance is retained.

Return values

ta_c_rc_ok	Object instance written to terminal_status. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	terminal_status is null-pointer.

◆ ta_terminal_get_transaction_data()

ta_e_result_code_t ta_terminal_get_transaction_data	(	ta_object_t	terminal,
		ta_object_t *	transaction_data
	)

Transaction data to use for transaction requests unless set manually.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	transaction_data	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not set in terminal. If object instance is not ta_object_invalid it is of type transaction_data and will be retained.

Return values

ta_c_rc_ok	Object instance written to transaction_data. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	transaction_data is null-pointer.

◆ ta_terminal_get_user_id()

ta_e_result_code_t ta_terminal_get_user_id	(	ta_object_t	terminal,
		int *	user_id
	)

User identifier.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	user_id	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Value written to user_id.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	user_id is null-pointer.

◆ ta_terminal_hardware_information()

ta_e_result_code_t ta_terminal_hardware_information	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Get hardware information from the EFT Terminal.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type hardware_information_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_hardware_information_async()

ta_e_result_code_t ta_terminal_hardware_information_async ( ta_object_t terminal )

Get hardware information from the EFT Terminal.

Asynchronous version of ta_terminal_hardware_information. Callback function is ta_cb_terminal_hardware_information_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_has_sw_update()

ta_e_result_code_t ta_terminal_has_sw_update	(	ta_object_t	terminal,
		ta_e_boolean_t *	result
	)

Software update is available.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	result	Pointer to variable to write result to.

Return values

ta_c_rc_ok	Result written to result.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is null-pointer.

◆ ta_terminal_hold_commit()

ta_e_result_code_t ta_terminal_hold_commit ( ta_object_t terminal )

Extends the Commit timeout if the terminal needs additional time before the Commit shall be performed.

An example could be on a public transport vending machine: if the machine is printing multiple tickets and this printing action would extend the commit timeout, a hold_commit notification shall be sent to extend the Commit timeout as well. If the printing action fails after some tickets a partial commit can be performed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Hold commit send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_init_transaction()

ta_e_result_code_t ta_terminal_init_transaction	(	ta_object_t	terminal,
		ta_e_boolean_t	display_amount,
		ta_object_t	amount,
		ta_object_t *	response
	)

Initialize a transaction knowing the amount or the card type.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	display_amount	ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal.
[in]	amount	Object instance of type amount. Can be ta_object_invalid to not use an amount. display_amount has no effect if not amount is used.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in the response. Otherwise object instance is of type card_data. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. If object instance is not ta_object_invalid object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_init_transaction2()

ta_e_result_code_t ta_terminal_init_transaction2	(	ta_object_t	terminal,
		ta_e_boolean_t	display_amount,
		ta_object_t	amount,
		ta_e_function_hint_t	function_hint,
		ta_object_t *	response
	)

Initialize a transaction knowing the amount or the card type.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	display_amount	ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal.
[in]	amount	Object instance of type amount. Can be ta_object_invalid to not use an amount. display_amount has no effect if not amount is used.
[in]	function_hint	Function hint.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in the response. Otherwise object instance is of type card_data. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. If object instance is not ta_object_invalid object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_init_transaction2_async()

ta_e_result_code_t ta_terminal_init_transaction2_async	(	ta_object_t	terminal,
		ta_e_boolean_t	display_amount,
		ta_object_t	amount,
		ta_e_function_hint_t	function_hint
	)

Initialize a transaction knowing the amount or the card type.

Asynchronous version of ta_terminal_init_transaction. Callback function is ta_cb_terminal_init_transaction_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	display_amount	ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal.
[in]	amount	Object instance of type amount. Can be ta_object_invalid to not use an amount. display_amount has no effect if not amount is used.
[in]	function_hint	Function hint.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.

◆ ta_terminal_init_transaction_async()

ta_e_result_code_t ta_terminal_init_transaction_async	(	ta_object_t	terminal,
		ta_e_boolean_t	display_amount,
		ta_object_t	amount
	)

Initialize a transaction knowing the amount or the card type.

Asynchronous version of ta_terminal_init_transaction. Callback function is ta_cb_terminal_init_transaction_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	display_amount	ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal.
[in]	amount	Object instance of type amount. Can be ta_object_invalid to not use an amount. display_amount has no effect if not amount is used.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.

◆ ta_terminal_init_transaction_with_dialog()

ta_e_result_code_t ta_terminal_init_transaction_with_dialog	(	ta_object_t	terminal,
		ta_object_t	amount,
		ta_e_function_hint_t	function_hint,
		ta_object_t	dialog,
		ta_object_t *	response
	)

Initialize a transaction with dialog.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount.
[in]	function_hint	Function hint.
[in]	dialog	Object instance of type show_dialog_request.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in the response. Otherwise object instance is of type init_transaction_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. If object instance is not ta_object_invalid object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.
ta_c_rc_invalid_argument	dialog is not ta_object_invalid and is not of type show_dialog_request.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_init_transaction_with_dialog_async()

ta_e_result_code_t ta_terminal_init_transaction_with_dialog_async	(	ta_object_t	terminal,
		ta_object_t	amount,
		ta_e_function_hint_t	function_hint,
		ta_object_t	dialog
	)

Initialize a transaction with dialog.

Asynchronous version of ta_terminal_init_transaction_with_dialog. Callback function is ta_cb_terminal_init_transaction_with_dialog_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	amount	Object instance of type amount.
[in]	function_hint	Function hint.
[in]	dialog	Object instance of type show_dialog_request.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.
ta_c_rc_invalid_argument	dialog is not ta_object_invalid and is not of type show_dialog_request.

◆ ta_terminal_login()

ta_e_result_code_t ta_terminal_login ( ta_object_t terminal )

Activate a communication session between the ECR and the terminal.

Note: Before calling set the print options, POS identifier and manufacturer flags set in the terminal instance.

Side-Effect:

After completing the request updates the features, brands and terminal identifier in the terminal instance. Fetching these information can be disabled if Auto-FetchBrands is disabled terminal_settings

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_login_async()

ta_e_result_code_t ta_terminal_login_async ( ta_object_t terminal )

Activate a communication session between the ECR and the terminal.

Asynchronous version of ta_terminal_login. Callback function is ta_cb_terminal_login_completed.

Note: Before calling set the print options, POS identifier and manufacturer flags set in the terminal instance.

Side-Effect:

After completing the request updates the features, brands and terminal identifier in the terminal instance. Fetching these information can be disabled if Auto-FetchBrands is disabled terminal_settings

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_logout()

ta_e_result_code_t ta_terminal_logout ( ta_object_t terminal )

Terminates an active communication session between the ECR and the terminal.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_logout_async()

ta_e_result_code_t ta_terminal_logout_async ( ta_object_t terminal )

Terminates an active communication session between the ECR and the terminal.

Asynchronous version of ta_terminal_logout. Callback function is ta_cb_terminal_logout_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_loyalty_data()

ta_e_result_code_t ta_terminal_loyalty_data	(	ta_object_t	terminal,
		ta_e_loyalty_function_type_t	function_type,
		ta_object_t	data_type,
		ta_object_t	data,
		ta_e_boolean_t	retain_card,
		ta_object_t *	response
	)

This function is used to query and configure loyalty information.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	function_type	Defines what kind of loyalty mode will be used.
[in]	data_type	Specifies type of loyalty data. Mandatory for function_type ta_c_lft_init, ta_c_lft_update and ta_c_lft_deinit. If not ta_object_invalid has to be of type string.
[in]	data	Loyalty data. Object of type string.
[in]	retain_card	ta_c_b_true to not eject card otherwise ta_c_b_false.
[out]	response	Variable to write object of type card_data.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	function_type is not a valid value of ta_e_loyalty_function_type_t.
ta_c_rc_invalid_argument	data_type is not ta_object_invalid and is not of type string.
ta_c_rc_invalid_argument	data is ta_object_invalid.
ta_c_rc_invalid_argument	data is not of type string.
ta_c_rc_invalid_argument	retain_card is ta_c_b_undefined.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_loyalty_data_async()

ta_e_result_code_t ta_terminal_loyalty_data_async	(	ta_object_t	terminal,
		ta_e_loyalty_function_type_t	function_type,
		ta_object_t	data_type,
		ta_object_t	data,
		ta_e_boolean_t	retain_card
	)

This function is used to query and configure loyalty information.

Asynchronous version of ta_terminal_loyalty_data. Callback function is ta_cb_terminal_loyalty_data_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	function_type	Defines what kind of loyalty mode will be used.
[in]	data_type	Specifies type of loyalty data. Mandatory for function_type ta_c_lft_init, ta_c_lft_update and ta_c_lft_deinit. If not ta_object_invalid has to be of type string.
[in]	data	Loyalty data. Object of type string.
[in]	retain_card	ta_c_b_true to not eject card otherwise ta_c_b_false.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	function_type is not a valid value of ta_e_loyalty_function_type_t.
ta_c_rc_invalid_argument	data_type is not ta_object_invalid and is not of type string.
ta_c_rc_invalid_argument	data is ta_object_invalid.
ta_c_rc_invalid_argument	data is not of type string.
ta_c_rc_invalid_argument	retain_card is ta_c_b_undefined.

◆ ta_terminal_mobile_topup()

ta_e_result_code_t ta_terminal_mobile_topup	(	ta_object_t	terminal,
		ta_e_mobile_topup_type_t	type,
		ta_object_t	issuer_name,
		ta_object_t	amount,
		ta_object_t *	response
	)

Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL.

To use REVERSAL terminal has to be configured to support credit transactions.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	issuer_name	Object of type string.
[in]	amount	Object of type amount.
[out]	response	Variable to write object of type mobile_topup_data.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is ta_object_invalid.
ta_c_rc_invalid_argument	result is not of type mobile_topup_data.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_mobile_topup2()

ta_e_result_code_t ta_terminal_mobile_topup2	(	ta_object_t	terminal,
		ta_e_mobile_topup_type_t	type,
		ta_object_t	value,
		ta_object_t *	response
	)

Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL.

To use REVERSAL terminal has to be configured to support credit transactions.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	value	Object of type mobile_topup_value.
[out]	response	Variable to write object of type mobile_topup_data.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is ta_object_invalid.
ta_c_rc_invalid_argument	result is not of type mobile_topup_data.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_mobile_topup2_async()

ta_e_result_code_t ta_terminal_mobile_topup2_async	(	ta_object_t	terminal,
		ta_e_mobile_topup_type_t	type,
		ta_object_t	value
	)

Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL.

To use REVERSAL terminal has to be configured to support credit transactions.

Asynchronous version of ta_terminal_mobile_topup. Callback function is ta_cb_terminal_mobile_topup_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	value	Object of type mobile_topup_value.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_mobile_topup_async()

ta_e_result_code_t ta_terminal_mobile_topup_async	(	ta_object_t	terminal,
		ta_e_mobile_topup_type_t	type,
		ta_object_t	issuer_name,
		ta_object_t	amount
	)

Mobile Topup transaction. Supported transaction type are PURCHASE and REVERSAL.

To use REVERSAL terminal has to be configured to support credit transactions.

Asynchronous version of ta_terminal_mobile_topup. Callback function is ta_cb_terminal_mobile_topup_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	issuer_name	Object of type string.
[in]	amount	Object of type amount.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_mobile_topup_issuer_info()

ta_e_result_code_t ta_terminal_mobile_topup_issuer_info	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Request Mobile Topup Issuer information.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Variable to write object of type list with entries of type mobile_topup_value.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_mobile_topup_issuer_info_async()

ta_e_result_code_t ta_terminal_mobile_topup_issuer_info_async ( ta_object_t terminal )

Request Mobile Topup Issuer information.

Asynchronous version of ta_terminal_mobile_topup_issuer_info. Callback function is ta_cb_terminal_mobile_topup_issuer_info_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_dialog_mode()

ta_e_result_code_t ta_terminal_open_dialog_mode ( ta_object_t terminal )

Open dialog mode on the terminal.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_dialog_mode2()

ta_e_result_code_t ta_terminal_open_dialog_mode2	(	ta_object_t	terminal,
		ta_e_boolean_t	silent
	)

Open dialog mode on the terminal.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	silent	After opening the Dialog Mode the last screen content is retained until the the first ShowDialog is received

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_dialog_mode2_async()

ta_e_result_code_t ta_terminal_open_dialog_mode2_async	(	ta_object_t	terminal,
		ta_e_boolean_t	silent
	)

Open dialog mode on the terminal.

Asynchronous version of ta_terminal_open_dialog_mode. Callback function is ta_cb_terminal_open_dialog_mode_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	silent	After opening the Dialog Mode the last screen content is retained until the the first ShowDialog is received

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_dialog_mode_async()

ta_e_result_code_t ta_terminal_open_dialog_mode_async ( ta_object_t terminal )

Open dialog mode on the terminal.

Asynchronous version of ta_terminal_open_dialog_mode. Callback function is ta_cb_terminal_open_dialog_mode_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_maintenance_window()

ta_e_result_code_t ta_terminal_open_maintenance_window ( ta_object_t terminal )

Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.

The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.

If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.

It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_maintenance_window_async()

ta_e_result_code_t ta_terminal_open_maintenance_window_async ( ta_object_t terminal )

Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.

The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.

If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.

It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.

Asynchronous version of ta_terminal_open_maintenance_window. Callback function is ta_cb_terminal_open_maintenance_window_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_reader()

ta_e_result_code_t ta_terminal_open_reader ( ta_object_t terminal )

Open the shutter of the card reader.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_open_reader_async()

ta_e_result_code_t ta_terminal_open_reader_async ( ta_object_t terminal )

Open the shutter of the card reader.

Asynchronous version of ta_terminal_open_reader. Callback function is ta_cb_terminal_open_reader_completed.

Note: This method is only available if guide unattended is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_print_on_terminal()

ta_e_result_code_t ta_terminal_print_on_terminal	(	ta_object_t	terminal,
		ta_object_t	ticket_data
	)

The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal.

The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	ticket_data	Object instance of type string.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	ticket_data is ta_object_invalid.
ta_c_rc_invalid_argument	ticket_data is not of type string.

◆ ta_terminal_print_on_terminal_async()

ta_e_result_code_t ta_terminal_print_on_terminal_async	(	ta_object_t	terminal,
		ta_object_t	ticket_data
	)

The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal.

The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].

Asynchronous version of ta_terminal_print_on_terminal. Callback function is ta_cb_terminal_print_on_terminal_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	ticket_data	Object instance of type string.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	ticket_data is ta_object_invalid.
ta_c_rc_invalid_argument	ticket_data is not of type string.

◆ ta_terminal_provide_loyalty_basket()

ta_e_result_code_t ta_terminal_provide_loyalty_basket	(	ta_object_t	terminal,
		ta_object_t	basket,
		ta_object_t *	response
	)

This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	basket	Object of type list to send. Object contains elements of type loyalty_item.
[out]	response	Variable to write object of type list. Object contains elements of type loyalty_item.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	basket is ta_object_invalid.
ta_c_rc_invalid_argument	basket is not of type list.
ta_c_rc_invalid_argument	Element in basket is ta_object_invalid.
ta_c_rc_invalid_argument	Element in basket is not of type loyalty_item.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_provide_loyalty_basket_async()

ta_e_result_code_t ta_terminal_provide_loyalty_basket_async	(	ta_object_t	terminal,
		ta_object_t	basket
	)

This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.

Asynchronous version of ta_terminal_provide_loyalty_basket. Callback function is ta_cb_terminal_provide_loyalty_basket_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	basket	Object of type list to send. Object contains elements of type loyalty_item.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_provide_vas_result()

ta_e_result_code_t ta_terminal_provide_vas_result	(	ta_object_t	terminal,
		ta_object_t	result,
		ta_object_t *	response
	)

This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.

Note: This method is only available if guide value added services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	result	Object of type vas_result to send.
[out]	response	Variable to write object of type vas_result.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	result is ta_object_invalid.
ta_c_rc_invalid_argument	result is not of type vas_result.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_provide_vas_result_async()

ta_e_result_code_t ta_terminal_provide_vas_result_async	(	ta_object_t	terminal,
		ta_object_t	result
	)

This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.

Asynchronous version of ta_terminal_provide_vas_result. Callback function is ta_cb_terminal_provide_vas_result_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	result	Object of type vas_result to send.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_reboot()

ta_e_result_code_t ta_terminal_reboot ( ta_object_t terminal )

Force the EFT Terminal to reboot.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_reboot_async()

ta_e_result_code_t ta_terminal_reboot_async ( ta_object_t terminal )

Force the EFT Terminal to reboot.

Asynchronous version of ta_terminal_reboot. Callback function is ta_cb_terminal_reboot_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_receipt_request()

ta_e_result_code_t ta_terminal_receipt_request	(	ta_object_t	terminal,
		ta_e_receipt_request_type_t	type,
		ta_object_t *	response
	)

Receive the latest receipt or a list of silent receipts.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Type of receipts to receive.
[out]	response	Pointer to variable to write object instance to. Object instance is of type receipt_request_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_receipt_request_async()

ta_e_result_code_t ta_terminal_receipt_request_async	(	ta_object_t	terminal,
		ta_e_receipt_request_type_t	type
	)

Receive the latest receipt or a list of silent receipts.

Asynchronous version of ta_terminal_receipt_request. Callback function is ta_cb_terminal_receipt_request_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Type of receipts to receive.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_reconciliation()

ta_e_result_code_t ta_terminal_reconciliation	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Force the EFT Terminal to transmit all financial transactions to the host system.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type reconciliation_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_reconciliation_async()

ta_e_result_code_t ta_terminal_reconciliation_async ( ta_object_t terminal )

Force the EFT Terminal to transmit all financial transactions to the host system.

Asynchronous version of ta_terminal_reconciliation. Callback function is ta_cb_terminal_reconciliation_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_reconfig()

ta_e_result_code_t ta_terminal_reconfig	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Force the EFT Terminal to get the configuration from the service center.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in response. Otherwise object instance is of type print_data. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. If object instance is not ta_object_invalid object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_reconfig_async()

ta_e_result_code_t ta_terminal_reconfig_async ( ta_object_t terminal )

Force the EFT Terminal to get the configuration from the service center.

Asynchronous version of ta_terminal_reconfig. Callback function is ta_cb_terminal_reconfig_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_remove_listener()

ta_e_result_code_t ta_terminal_remove_listener	(	ta_object_t	terminal,
		ta_object_t	listener
	)

Unregister listener.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	listener	Object instance of type terminal_listener.

Return values

ta_c_rc_ok	Listener removed from terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	listener is ta_object_invalid.

◆ ta_terminal_request_alias()

ta_e_result_code_t ta_terminal_request_alias	(	ta_object_t	terminal,
		ta_object_t	six_trans_ref,
		ta_object_t *	response
	)

The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions.

Saferpay offers these kind of transactions which can be performed only using a secure Alias that can be created out of card information from a precious transaction. This Alias then can be used to perform a transaction without having the same card present.

An Alias can be used for the following transactions:

Purchase
Credit
Reservation
Recurring

Parameters

[in]	terminal	Object instance of type terminal.
[in]	six_trans_ref	Object instance of type string.
[out]	response	Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	six_trans_ref is ta_object_invalid.
ta_c_rc_invalid_argument	six_trans_ref is not of type string.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_request_alias_async()

ta_e_result_code_t ta_terminal_request_alias_async	(	ta_object_t	terminal,
		ta_object_t	six_trans_ref
	)

The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions.

Saferpay offers these kind of transactions which can be performed only using a secure Alias that can be created out of card information from a precious transaction. This Alias then can be used to perform a transaction without having the same card present.

An Alias can be used for the following transactions:

Purchase
Credit
Reservation
Recurring

Asynchronous version of ta_terminal_request_alias. Callback function is ta_cb_terminal_request_alias_completed.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	six_trans_ref	Object instance of type string.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	six_trans_ref is ta_object_invalid.
ta_c_rc_invalid_argument	six_trans_ref is not of type string.

◆ ta_terminal_rollback()

ta_e_result_code_t ta_terminal_rollback	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization.

For payment protocols supporting the function a declined receipt may be generated.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is ta_object_invalid if not contained in response. Otherwise object instance is of type print_data. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_rollback_async()

ta_e_result_code_t ta_terminal_rollback_async ( ta_object_t terminal )

Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization.

For payment protocols supporting the function a declined receipt may be generated.

Asynchronous version of ta_terminal_rollback. Callback function is ta_cb_terminal_rollback_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_screenshot()

ta_e_result_code_t ta_terminal_screenshot ( ta_object_t terminal )

Send notification to request EFT make a screenshot.

This is a "best effort" function.

Note: This method is only available if guide remote is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Hold commit send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_send_card_command()

ta_e_result_code_t ta_terminal_send_card_command	(	ta_object_t	terminal,
		ta_object_t	requests,
		ta_object_t *	responses
	)

Send card command.

This function is used for a direct communication with the inserted card using APDUs. It is possible to send a list of APDU command in the request (sixml:CommandRequestList) and to set responses that shall be accepted as "Positive" responses using sixml:PositiveAnswerList

Each sixml:CommandRequest is numbered with a unique order number (starting with 1). In the response, the terminal sends the response of the device for each CommandRequest, including the order number of the request.

If the device answers with a negative response (i.e. SW1SW2 != 9000 or other as "positive" defined answers using sixml:PositiveAnswerList), the processing of the sixml:CommandRequests is aborted, and the remaining commands are not sent to the device.

Furthermore it can be defined which dialogs shall be shown using the container sixml:CommandResources in the following use cases:

Dialog shown as preparation before sending an APDU command: sixml:PreResource
Dialog shown during APDU command execution: sixml:ExecutionResource
Dialog shown after receiving a positive response: sixml:PositiveResource
Dialog shown after receiving a negative response: sixml:NegativeResource

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	requests	Object instance of type list. Elements in the list have to be of type command_request.
[out]	responses	Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type command_response.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	requests is ta_object_invalid.
ta_c_rc_invalid_argument	requests is not of type list.
ta_c_rc_invalid_argument	Element in requests is ta_object_invalid.
ta_c_rc_invalid_argument	Element in requests is not of type command_request.
ta_c_rc_invalid_argument	responses is null-pointer.

◆ ta_terminal_send_card_command_async()

ta_e_result_code_t ta_terminal_send_card_command_async	(	ta_object_t	terminal,
		ta_object_t	requests
	)

Send card command.

Asynchronous version of ta_terminal_send_card_command. Callback function is ta_cb_terminal_send_card_command_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	requests	Object instance of type list. Elements in the list have to be of type command_request.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	Element in requests is ta_object_invalid.
ta_c_rc_invalid_argument	Element in requests is not of type command_request.

◆ ta_terminal_set_allowed_third_party_apps()

ta_e_result_code_t ta_terminal_set_allowed_third_party_apps	(	ta_object_t	terminal,
		int	allowed_third_party_apps
	)

Set allowed third party apps.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	allowed_third_party_apps	OR combined flags from ta_e_allowed_third_party_apps_t.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	allowed_third_party_apps is null-pointer.

◆ ta_terminal_set_custom_logger()

ta_e_result_code_t ta_terminal_set_custom_logger	(	ta_object_t	terminal,
		ta_cb_publish_log_record	callback,
		void *	user_pointer
	)

Set custom terminal logger callback.

If not null-pointer the callback is used whenever the terminal logger needs to publish a new log record. The terminal logger is used whenever a terminal function is called, hence any function of ta_terminal_*. In all other cases the global logger is used. You can use the same logger for both global and terminal specific logging. If no custom terminal logger is set the global one is used if set.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	callback	Callback to set. Can be null-pointer to disable.
[in]	user_pointer	User pointer to use in the callback.

Return values

ta_c_rc_ok	Listener removed from terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.

◆ ta_terminal_set_customer_data()

ta_e_result_code_t ta_terminal_set_customer_data	(	ta_object_t	terminal,
		ta_object_t	customer_data
	)

Set Customer data.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	customer_data	Object instance to set. Object instance has to be of type map. Elements in the list have to be of key type integer with values from enumeration ta_e_customer_data_type_t and value type string.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	customer_data is ta_object_invalid.
ta_c_rc_invalid_argument	customer_data is not of type map.
ta_c_rc_invalid_argument	Element value in customer_data is ta_object_invalid.
ta_c_rc_invalid_argument	Element key in customer_data is not of type integer with values from enumeration ta_e_customer_data_type_t.
ta_c_rc_invalid_argument	Element value in customer_data is not of type string.

◆ ta_terminal_set_ecr_data()

ta_e_result_code_t ta_terminal_set_ecr_data	(	ta_object_t	terminal,
		ta_object_t	ecr_data
	)

Set ECR Data.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	ecr_data	Object instance to set. Object instance has to be of type list. Elements in the list have to be of type ecr_info.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	ecr_data is ta_object_invalid.
ta_c_rc_invalid_argument	ecr_data is not of type list.
ta_c_rc_invalid_argument	Element in ecr_data is ta_object_invalid.
ta_c_rc_invalid_argument	Element in ecr_data is not of type ecr_info.

◆ ta_terminal_set_merchant_options()

ta_e_result_code_t ta_terminal_set_merchant_options	(	ta_object_t	terminal,
		ta_object_t	merchant_options
	)

Set Merchant options.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	merchant_options	Object instance to set. Object instance has to be of type list. Elements in the list have to be of type merchant_option.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	merchant_options is ta_object_invalid.
ta_c_rc_invalid_argument	merchant_options is not of type list.
ta_c_rc_invalid_argument	Element in merchant_options is ta_object_invalid.
ta_c_rc_invalid_argument	Element in merchant_options is not of type merchant_option.

◆ ta_terminal_set_pos_id()

ta_e_result_code_t ta_terminal_set_pos_id	(	ta_object_t	terminal,
		ta_object_t	pos_id
	)

Set POS identifier.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	pos_id	Object instance to set. Object instance has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	pos_id is ta_object_invalid.
ta_c_rc_invalid_argument	pos_id is not of type string.

◆ ta_terminal_set_print_options()

ta_e_result_code_t ta_terminal_set_print_options	(	ta_object_t	terminal,
		ta_object_t	print_options
	)

Set Print options.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	print_options	Object instance to set. Object instance has to be of type list. Elements in the list have to be of type print_option.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	print_options is ta_object_invalid.
ta_c_rc_invalid_argument	print_options is not of type list.
ta_c_rc_invalid_argument	Element in print_options is ta_object_invalid.
ta_c_rc_invalid_argument	Element in print_options is not of type print_option.

◆ ta_terminal_set_receipt_formatter()

ta_e_result_code_t ta_terminal_set_receipt_formatter	(	ta_object_t	terminal,
		ta_object_t	formatter
	)

Set receipt formatter.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	formatter	Object instance to set. Object instance can be ta_object_invalid to clear the value in terminal. If object instance is not ta_object_invalid it has to be of type receipt_formatter.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	formatter is not ta_object_invalid and is not of type receipt_formatter.

◆ ta_terminal_set_transaction_data()

ta_e_result_code_t ta_terminal_set_transaction_data	(	ta_object_t	terminal,
		ta_object_t	transaction_data
	)

Set transaction data to use for transaction requests unless set manually.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	transaction_data	Object instance to set. Object instance can be ta_object_invalid to clear the value in terminal. If object instance is not ta_object_invalid it has to be of type transaction_data.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	transaction_data is not ta_object_invalid and is not of type transaction_data.

◆ ta_terminal_set_user_id()

ta_e_result_code_t ta_terminal_set_user_id	(	ta_object_t	terminal,
		int	user_id
	)

Set User identifier.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	user_id	Value to set.

Return values

ta_c_rc_ok	Object instance assigned to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	user_id is less than 0.

◆ ta_terminal_show_dialog()

ta_e_result_code_t ta_terminal_show_dialog	(	ta_object_t	terminal,
		ta_object_t	request,
		ta_object_t *	response
	)

Show dialog on the terminal.

Can be called only if dialog mode is open.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	request	Object instance of type show_dialog_request.
[out]	response	Pointer to variable to write object instance to. Object instance is of type show_dialog_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_dialog_request.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_show_dialog_async()

ta_e_result_code_t ta_terminal_show_dialog_async	(	ta_object_t	terminal,
		ta_object_t	request
	)

Show dialog on the terminal.

Asynchronous version of ta_terminal_show_dialog. Callback function is ta_cb_terminal_show_dialog_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	request	Object instance of type show_dialog_request.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_dialog_request.

◆ ta_terminal_show_signature_capture()

ta_e_result_code_t ta_terminal_show_signature_capture	(	ta_object_t	terminal,
		ta_object_t	request,
		ta_object_t *	response
	)

Show signature capture on the terminal.

Can be called only if dialog mode is open.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	request	Object instance of type show_signature_capture_request.
[out]	response	Pointer to variable to write object instance to. Object instance is of type show_signature_capture_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_show_signature_capture_async()

ta_e_result_code_t ta_terminal_show_signature_capture_async	(	ta_object_t	terminal,
		ta_object_t	request
	)

Request system information from the EFT Terminal.

Asynchronous version of ta_terminal_show_signature_capture. Callback function is ta_cb_terminal_show_signature_capture_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	request	Object instance of type show_signature_capture_request.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type show_signature_capture_request.

◆ ta_terminal_software_update()

ta_e_result_code_t ta_terminal_software_update	(	ta_object_t	terminal,
		ta_e_update_status_t *	response
	)

Force the EFT Terminal to start a Software Update.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Request finished successfully. Value written to response.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_software_update_async()

ta_e_result_code_t ta_terminal_software_update_async ( ta_object_t terminal )

Force the EFT Terminal to start a Software Update.

Asynchronous version of ta_terminal_software_update. Callback function is ta_cb_terminal_software_update_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_start_checkout()

ta_e_result_code_t ta_terminal_start_checkout ( ta_object_t terminal )

This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started.

Therefore the Worldline QR code is displayed at the terminal. The timeout how long the QR code shall be displayed on the terminal before returning to its Idle screen can be defined in the Login request using the OptionType - QRCTimeout, see SIXml Book C: Appendix for further information.

Note: This method is only available if guide value added services is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request finished successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_start_checkout_async()

ta_e_result_code_t ta_terminal_start_checkout_async ( ta_object_t terminal )

This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started.

Therefore the Worldline QR code is displayed at the terminal. The timeout how long the QR code shall be displayed on the terminal before returning to its Idle screen can be defined in the Login request using the OptionType - QRCTimeout, see SIXml Book C: Appendix for further information.

Asynchronous version of ta_terminal_start_checkout. Callback function is ta_cb_terminal_start_checkout_completed.

Note: This method is only available if guide dialog is enabled.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_system_information()

ta_e_result_code_t ta_terminal_system_information	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Request system information from the EFT Terminal.

Note: Set EcrData property before calling SystemInformation.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type system_information_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_system_information_async()

ta_e_result_code_t ta_terminal_system_information_async ( ta_object_t terminal )

Request system information from the EFT Terminal.

Asynchronous version of ta_terminal_system_information. Callback function is ta_cb_terminal_system_information_completed.

Note: Set EcrData property before calling SystemInformation.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_third_party_app_data()

ta_e_result_code_t ta_terminal_third_party_app_data	(	ta_object_t	terminal,
		ta_object_t	data
	)

Send third_party_app_data to request EFT make a screenshot.

This is a "best effort" function.

Note: This method is only available if guide value_added_services is enabled.

Parameters

[in]	terminal	Object instance of type terminal.
[in]	payload	Object instance of type third_party_app_payload.

Return values

ta_c_rc_ok	third_party_app_data send to terminal.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	terminal is ta_object_invalid or not of type third_party_app_payload.

◆ ta_terminal_transaction()

ta_e_result_code_t ta_terminal_transaction	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount,
		ta_object_t *	response
	)

Starts an EFT Terminal Transaction.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.
[out]	response	Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_transaction2()

ta_e_result_code_t ta_terminal_transaction2	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	request,
		ta_object_t *	response
	)

Starts an EFT Terminal Transaction.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	request	Object instance of type transaction_request.
[out]	response	Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_transaction2_async()

ta_e_result_code_t ta_terminal_transaction2_async	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	request
	)

Starts an EFT Terminal Transaction.

Asynchronous version of ta_terminal_transaction2. Callback function is ta_cb_terminal_transaction_completed.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	request	Object instance of type transaction_request.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	request is ta_object_invalid.
ta_c_rc_invalid_argument	request is not of type transaction_request.

◆ ta_terminal_transaction_async()

ta_e_result_code_t ta_terminal_transaction_async	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount
	)

Starts an EFT Terminal Transaction.

Asynchronous version of ta_terminal_transaction. Callback function is ta_cb_terminal_transaction_completed.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.

◆ ta_terminal_transaction_cashback()

ta_e_result_code_t ta_terminal_transaction_cashback	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount,
		ta_object_t	amount_cashback,
		ta_object_t *	response
	)

Starts an EFT Terminal Transaction.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.
[in]	amount_cashback	Object instance of type amount.
[out]	response	Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount_cashback is ta_object_invalid.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_transaction_cashback_async()

ta_e_result_code_t ta_terminal_transaction_cashback_async	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount,
		ta_object_t	amount_cashback
	)

Starts an EFT Terminal Transaction.

Asynchronous version of ta_terminal_transaction_cashback. Callback function is ta_cb_terminal_transaction_completed.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.
[in]	amount_cashback	Object instance of type amount.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount_cashback is ta_object_invalid.

◆ ta_terminal_transaction_info_request()

ta_e_result_code_t ta_terminal_transaction_info_request	(	ta_object_t	terminal,
		ta_object_t *	response
	)

Receive the latest transaction information.

Parameters

[in]	terminal	Object instance of type terminal.
[out]	response	Pointer to variable to write object instance to. Object instance is of type transaction_info_request_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_transaction_info_request_async()

ta_e_result_code_t ta_terminal_transaction_info_request_async ( ta_object_t terminal )

Receive the latest transaction information.

Asynchronous version of ta_terminal_transaction_info_request. Callback function is ta_cb_terminal_transaction_info_request_completed.

Parameters

[in] terminal Object instance of type terminal.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.

◆ ta_terminal_transaction_tip()

ta_e_result_code_t ta_terminal_transaction_tip	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount,
		ta_object_t	amount_tip,
		ta_object_t *	response
	)

Starts an EFT Terminal Transaction.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.
[in]	amount_tip	Object instance of type amount.
[out]	response	Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained.

Return values

ta_c_rc_ok	Request finished successfully. Object instance written to response. Object instance has been retained.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount_tip is ta_object_invalid.
ta_c_rc_invalid_argument	response is null-pointer.

◆ ta_terminal_transaction_tip_async()

ta_e_result_code_t ta_terminal_transaction_tip_async	(	ta_object_t	terminal,
		ta_e_transaction_type_t	type,
		ta_object_t	amount,
		ta_object_t	amount_tip
	)

Starts an EFT Terminal Transaction.

Asynchronous version of ta_terminal_transaction_tip. Callback function is ta_cb_terminal_transaction_completed.

Note: The transaction parameters are taken from TransactionRequest terminal property since those do not change often if at all (default parameters).

Parameters

[in]	terminal	Object instance of type terminal.
[in]	type	Transaction type.
[in]	amount	Object instance of type amount.
[in]	amount_tip	Object instance of type amount.

Return values

ta_c_rc_ok	Request started successfully.
ta_c_rc_invalid_argument	terminal is ta_object_invalid.
ta_c_rc_invalid_argument	terminal is not of type terminal.
ta_c_rc_invalid_argument	terminal has been disposed.
ta_c_rc_invalid_argument	amount is ta_object_invalid.
ta_c_rc_invalid_argument	amount_tip is ta_object_invalid.

Description

Functions

Function Documentation

◆ ta_terminal_activate()

◆ ta_terminal_activate_async()

◆ ta_terminal_activate_service_menu()

◆ ta_terminal_activate_service_menu_async()

◆ ta_terminal_add_ecr_data()

◆ ta_terminal_add_listener()

◆ ta_terminal_amt_adjustment()

◆ ta_terminal_amt_adjustment_2()

◆ ta_terminal_application_information()

◆ ta_terminal_application_information_async()

◆ ta_terminal_balance()

◆ ta_terminal_balance_async()

◆ ta_terminal_balance_inquiry()

◆ ta_terminal_balance_inquiry_async()

◆ ta_terminal_can_dcc()

◆ ta_terminal_can_declined_receipts()

◆ ta_terminal_can_multi_account_selection()

◆ ta_terminal_cancel()

◆ ta_terminal_cancel2()

◆ ta_terminal_change_language_for_request()

◆ ta_terminal_change_settings()

◆ ta_terminal_change_settings_async()

◆ ta_terminal_client_identification()

◆ ta_terminal_client_identification_async()

◆ ta_terminal_close_dialog_mode()

◆ ta_terminal_close_dialog_mode_async()

◆ ta_terminal_close_maintenance_window()

◆ ta_terminal_close_maintenance_window_async()

◆ ta_terminal_close_reader()

◆ ta_terminal_close_reader_async()

◆ ta_terminal_commit()

◆ ta_terminal_commit_amount()

◆ ta_terminal_commit_amount_async()

◆ ta_terminal_commit_async()

◆ ta_terminal_connect()

◆ ta_terminal_connect_async()

◆ ta_terminal_counter_request()

◆ ta_terminal_counter_request_async()

◆ ta_terminal_create()

◆ ta_terminal_dcc_rates()

◆ ta_terminal_dcc_rates_async()

◆ ta_terminal_deactivate()

◆ ta_terminal_deactivate_async()

◆ ta_terminal_device_maintenance()

◆ ta_terminal_device_maintenance_async()

◆ ta_terminal_disconnect()

◆ ta_terminal_disconnect_async()

◆ ta_terminal_dispose()

◆ ta_terminal_eject_card()

◆ ta_terminal_eject_card_async()

◆ ta_terminal_finish_checkout()

◆ ta_terminal_finish_checkout_async()

◆ ta_terminal_get_act_seq_counter()

◆ ta_terminal_get_allowed_third_party_apps()

◆ ta_terminal_get_brands()

◆ ta_terminal_get_config_data()

◆ ta_terminal_get_customer_data()

◆ ta_terminal_get_ecr_data()

◆ ta_terminal_get_features()

◆ ta_terminal_get_item_textcode()

◆ ta_terminal_get_item_textcode_description()

◆ ta_terminal_get_license()

◆ ta_terminal_get_merchant_options()

◆ ta_terminal_get_pos_id()

◆ ta_terminal_get_print_options()

◆ ta_terminal_get_receipt_formatter()

◆ ta_terminal_get_settings()

◆ ta_terminal_get_supported_languages()

◆ ta_terminal_get_terminal_id()

◆ ta_terminal_get_terminal_status()

◆ ta_terminal_get_transaction_data()

◆ ta_terminal_get_user_id()

◆ ta_terminal_hardware_information()

◆ ta_terminal_hardware_information_async()

◆ ta_terminal_has_sw_update()

◆ ta_terminal_hold_commit()

◆ ta_terminal_init_transaction()