TIM SDK
TIM API C
terminal_settings.h File Reference

Description

Terminal settings.

Object type terminal_settings.

Functions

ta_e_result_code_t ta_terminal_settings_create (ta_object_t *settings)
 Create terminal settings. More...
 
ta_e_result_code_t ta_terminal_settings_get_log_dir (ta_object_t settings, ta_object_t *log_dir)
 Deprecated: Defines where the Log File has to be generated. More...
 
ta_e_result_code_t ta_terminal_settings_set_log_dir (ta_object_t settings, ta_object_t log_dir)
 Deprecated: Set where the Log File has to be generated. More...
 
ta_e_result_code_t ta_terminal_settings_get_log_retain_file_count (ta_object_t settings, int *file_count)
 Deprecated: Number of log files to keep before archiving them. More...
 
ta_e_result_code_t ta_terminal_settings_set_log_retain_file_count (ta_object_t settings, int retain_file_count)
 Deprecated: Set number of log files to keep before archiving them. More...
 
ta_e_result_code_t ta_terminal_settings_get_log_file_count_per_archive (ta_object_t settings, int *file_count_per_archive)
 Deprecated: Number of log files to keep before per archive file. More...
 
ta_e_result_code_t ta_terminal_settings_set_log_file_count_per_archive (ta_object_t settings, int log_file_count_per_archive)
 Deprecated: Set number of log files to keep before per archive file. More...
 
ta_e_result_code_t ta_terminal_settings_get_log_retain_archive_count (ta_object_t settings, int *archive_count)
 Deprecated: Number of log file archives to keep before deleting them. More...
 
ta_e_result_code_t ta_terminal_settings_set_log_retain_archive_count (ta_object_t settings, int log_retain_archive_count)
 Deprecated: Set number of log file archives to keep before deleting them. More...
 
ta_e_result_code_t ta_terminal_settings_get_terminal_id (ta_object_t settings, ta_object_t *terminal_id)
 Terminal ID to be broadcasted in case of ConnectionMode Broadcast. More...
 
ta_e_result_code_t ta_terminal_settings_set_terminal_id (ta_object_t settings, ta_object_t terminal_id)
 Set terminal ID to be broadcasted in case of ConnectionMode Broadcast. More...
 
ta_e_result_code_t ta_terminal_settings_get_connection_mode (ta_object_t settings, ta_e_connection_mode_t *connection_mode)
 Broadcast (default) or OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_set_connection_mode (ta_object_t settings, ta_e_connection_mode_t connection_mode)
 Set broadcast (default) or OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_get_connection_ip_string (ta_object_t settings, ta_object_t *connection_ip_string)
 IP address of the EFT terminal in case of ConnectionMode OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_set_connection_ip_string (ta_object_t settings, ta_object_t connection_ip_string)
 Set IP address of the EFT terminal in case of ConnectionMode OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_get_connection_ip_port (ta_object_t settings, int *connection_ip_port)
 Listening Port of the EFT terminal in case of ConnectionMode OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_set_connection_ip_port (ta_object_t settings, int connection_ip_port)
 Listening Port of the EFT terminal in case of ConnectionMode OnFixIP. More...
 
ta_e_result_code_t ta_terminal_settings_get_broadcast_interface (ta_object_t settings, ta_object_t *broadcast_interface)
 Interface to use for broadcasting or empty string to broadcast on all available interfaces. More...
 
ta_e_result_code_t ta_terminal_settings_set_broadcast_interface (ta_object_t settings, ta_object_t broadcast_interface)
 Set Interface to use for broadcasting or empty string to broadcast on all available interfaces. More...
 
ta_e_result_code_t ta_terminal_settings_get_protocol_type (ta_object_t settings, ta_e_protocol_type_t *protocol_type)
 Protocol type. More...
 
ta_e_result_code_t ta_terminal_settings_set_protocol_type (ta_object_t settings, ta_e_protocol_type_t protocol_type)
 Set protocol type. More...
 
ta_e_result_code_t ta_terminal_settings_get_integrator_id (ta_object_t settings, ta_object_t *integrator_id)
 Integrator identifier. More...
 
ta_e_result_code_t ta_terminal_settings_set_integrator_id (ta_object_t settings, ta_object_t integrator_id)
 Set integrator identifier. More...
 
ta_e_result_code_t ta_terminal_settings_get_guides (ta_object_t settings, int *guides)
 Required guides. More...
 
ta_e_result_code_t ta_terminal_settings_set_guides (ta_object_t settings, int guides)
 Required guides. More...
 
ta_e_result_code_t ta_terminal_settings_get_manufacturer_flags (ta_object_t settings, int *manufacturer_flags)
 Manufacturer flags. More...
 
ta_e_result_code_t ta_terminal_settings_set_manufacturer_flags (ta_object_t settings, int manufacturer_flags)
 Set manufacturer flags. More...
 
ta_e_result_code_t ta_terminal_settings_is_fetch_brands (ta_object_t settings, ta_e_boolean_t *is_fetch_brands)
 Automatically retrieves application information during logging in. More...
 
ta_e_result_code_t ta_terminal_settings_set_fetch_brands (ta_object_t settings, ta_e_boolean_t fetch_brands)
 Automatically retrieves application information during logging in. More...
 
ta_e_result_code_t ta_terminal_settings_is_auto_commit (ta_object_t settings, ta_e_boolean_t *is_auto_commit)
 After executing the Transaction- function the API commits the transaction automatically. More...
 
ta_e_result_code_t ta_terminal_settings_set_auto_commit (ta_object_t settings, ta_e_boolean_t auto_commit)
 After executing the Transaction- function the API commits the transaction automatically. More...
 
ta_e_result_code_t ta_terminal_settings_is_auto_shift_management (ta_object_t settings, ta_e_boolean_t *is_auto_shift_management)
 Shift management is handled automatically. More...
 
ta_e_result_code_t ta_terminal_settings_set_auto_shift_management (ta_object_t settings, ta_e_boolean_t auto_shift_management)
 Shift management is handled automatically. More...
 
ta_e_result_code_t ta_terminal_settings_is_auto_shutter_management (ta_object_t settings, ta_e_boolean_t *is_auto_shutter_management)
 Shutter management is handled automatically. More...
 
ta_e_result_code_t ta_terminal_settings_set_auto_shutter_management (ta_object_t settings, ta_e_boolean_t auto_shutter_management)
 Shutter management is handled automatically. More...
 
ta_e_result_code_t ta_terminal_settings_get_card_insertion_timeout (ta_object_t settings, int *card_insertion_timeout)
 Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request. More...
 
ta_e_result_code_t ta_terminal_settings_set_card_insertion_timeout (ta_object_t settings, int card_insertion_timeout)
 Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request. More...
 
ta_e_result_code_t ta_terminal_settings_get_card_removal_timeout (ta_object_t settings, int *card_removal_timeout)
 Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction. More...
 
ta_e_result_code_t ta_terminal_settings_set_card_removal_timeout (ta_object_t settings, int card_removal_timeout)
 Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction. More...
 
ta_e_result_code_t ta_terminal_settings_get_commit_timeout (ta_object_t settings, int *commit_timeout)
 Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. More...
 
ta_e_result_code_t ta_terminal_settings_set_commit_timeout (ta_object_t settings, int commit_timeout)
 Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received. More...
 
ta_e_result_code_t ta_terminal_settings_is_dcc (ta_object_t settings, ta_e_boolean_t *is_dcc)
 Dcc shall be supported. More...
 
ta_e_result_code_t ta_terminal_settings_set_dcc (ta_object_t settings, ta_e_boolean_t dcc)
 Set if Dcc shall be supported. More...
 
ta_e_result_code_t ta_terminal_settings_is_partial_approval (ta_object_t settings, ta_e_boolean_t *is_partial_approval)
 Partial approval shall be supported. More...
 
ta_e_result_code_t ta_terminal_settings_set_partial_approval (ta_object_t settings, ta_e_boolean_t partial_approval)
 Set if partial approval shall be supported. More...
 
ta_e_result_code_t ta_terminal_settings_get_proceed_timeout (ta_object_t settings, int *proceed_timeout)
 Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned. More...
 
ta_e_result_code_t ta_terminal_settings_set_proceed_timeout (ta_object_t settings, int proceed_timeout)
 Set timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned. More...
 
ta_e_result_code_t ta_terminal_settings_is_allow_closed_card_insert (ta_object_t settings, ta_e_boolean_t *is_allow_closed_card_insert)
 Allow card to be inserted before activation. More...
 
ta_e_result_code_t ta_terminal_settings_set_allow_closed_card_insert (ta_object_t settings, ta_e_boolean_t allow_closed_card_insert)
 Set allow card to be inserted before activation. More...
 
ta_e_result_code_t ta_terminal_settings_is_tip_allowed (ta_object_t settings, ta_e_boolean_t *is_tip_allowed)
 Tip is allowed for purchase transactions. More...
 
ta_e_result_code_t ta_terminal_settings_set_tip_allowed (ta_object_t settings, ta_e_boolean_t tip_allowed)
 Set tip is allowed for purchase transactions. More...
 
ta_e_result_code_t ta_terminal_settings_is_fast_ntf_mode (ta_object_t settings, ta_e_boolean_t *is_fast_ntf_mode)
 Enable fast notification mode. More...
 
ta_e_result_code_t ta_terminal_settings_set_fast_ntf_mode (ta_object_t settings, ta_e_boolean_t fast_ntf_mode)
 Set enable fast notification mode. More...
 
ta_e_result_code_t ta_terminal_settings_late_checkin_timeout (ta_object_t settings, int *timeout)
 This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin. More...
 
ta_e_result_code_t ta_terminal_settings_set_late_checkin_timeout (ta_object_t settings, int timeout)
 This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin. More...
 
ta_e_result_code_t ta_terminal_settings_get_request_repetition (ta_object_t settings, int *request_repetition)
 Number of send request repetitions or 0 to disable. More...
 
ta_e_result_code_t ta_terminal_settings_set_request_repetition (ta_object_t settings, int request_repetition)
 Set number of send request repetitions or 0 to disable. More...
 
ta_e_result_code_t ta_terminal_settings_is_enabled_keep_alive (ta_object_t settings, ta_e_boolean_t *is_enabled_keep_alive)
 Keep-Alive handling is enabled. More...
 
ta_e_result_code_t ta_terminal_settings_set_enabled_keep_alive (ta_object_t settings, ta_e_boolean_t enabled_keep_alive)
 Set Keep-Alive handling is enabled. More...
 
ta_e_result_code_t ta_terminal_settings_get_persistent_state (ta_object_t settings, ta_e_boolean_t *persistent_state)
 Enable persistent state if supported. More...
 
ta_e_result_code_t ta_terminal_settings_set_persistent_state (ta_object_t settings, ta_e_boolean_t persistent_state)
 Set Enable persistent state if supported. More...
 
ta_e_result_code_t ta_terminal_settings_get_saferpay_terminal_id (ta_object_t settings, ta_object_t *terminal_id)
 Saferpay: Terminal Id. More...
 
ta_e_result_code_t ta_terminal_settings_set_saferpay_terminal_id (ta_object_t settings, ta_object_t terminal_id)
 Set saferpay: Terminal Id. More...
 
ta_e_result_code_t ta_terminal_settings_get_saferpay_credentials (ta_object_t settings, ta_object_t *credentials)
 Saferpay: Base64 encoded user name + password. More...
 
ta_e_result_code_t ta_terminal_settings_set_saferpay_credentials (ta_object_t settings, ta_object_t credentials)
 Saferpay: Base64 encoded user name + password. More...
 
ta_e_result_code_t ta_terminal_settings_get_saferpay_customer_id (ta_object_t settings, ta_object_t *customer_id)
 Saferpay: Customer ID. More...
 
ta_e_result_code_t ta_terminal_settings_set_saferpay_customer_id (ta_object_t settings, ta_object_t customer_id)
 Saferpay: Customer ID. More...
 
ta_e_result_code_t ta_terminal_settings_get_saferpay_base_url (ta_object_t settings, ta_object_t *base_url)
 Saferpay: Base URL. More...
 
ta_e_result_code_t ta_terminal_settings_set_saferpay_base_url (ta_object_t settings, ta_object_t base_url)
 Saferpay: Base URL. More...
 

Function Documentation

◆ ta_terminal_settings_create()

ta_e_result_code_t ta_terminal_settings_create ( ta_object_t settings)

Create terminal settings.

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_settings_create has to be matched with a call to ta_object_release. The terminal instance is destroyed once nobody retains the terminal instance anymore.

Newly created terminal settings instances are mutable. Use ta_terminal_settings_freeze to turn terminal settings instances immutable. Frozen terminal instances return an error if setter functions are called. Terminal settings returned by the API are immutable by default.

Parameters
[out]settingsPointer to variable to write created object instance to. Created object instance is retained.
Return values
ta_c_rc_okObject instance has been created and written to settings.
ta_c_rc_invalid_argumentsettings is null-pointer.
ta_c_rc_out_of_memoryFailed allocating memory.

◆ ta_terminal_settings_get_broadcast_interface()

ta_e_result_code_t ta_terminal_settings_get_broadcast_interface ( ta_object_t  settings,
ta_object_t broadcast_interface 
)

Interface to use for broadcasting or empty string to broadcast on all available interfaces.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]broadcast_interfacePointer to variable to write object instance to. Object instance is of type string and is not retained. in settings.
Return values
ta_c_rc_okObject instance written to broadcast_interface.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentbroadcast_interface is null-pointer.

◆ ta_terminal_settings_get_card_insertion_timeout()

ta_e_result_code_t ta_terminal_settings_get_card_insertion_timeout ( ta_object_t  settings,
int *  card_insertion_timeout 
)

Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]card_insertion_timeoutPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to card_insertion_timeout.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcard_insertion_timeout is null-pointer.

◆ ta_terminal_settings_get_card_removal_timeout()

ta_e_result_code_t ta_terminal_settings_get_card_removal_timeout ( ta_object_t  settings,
int *  card_removal_timeout 
)

Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]card_removal_timeoutPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to card_removal_timeout.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcard_removal_timeout is null-pointer.

◆ ta_terminal_settings_get_commit_timeout()

ta_e_result_code_t ta_terminal_settings_get_commit_timeout ( ta_object_t  settings,
int *  commit_timeout 
)

Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received.

Timer starts with response and is reset in case client enters information in the terminal.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]commit_timeoutPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to commit_timeout.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcommit_timeout is null-pointer.

◆ ta_terminal_settings_get_connection_ip_port()

ta_e_result_code_t ta_terminal_settings_get_connection_ip_port ( ta_object_t  settings,
int *  connection_ip_port 
)

Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]connection_ip_portPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to connection_ip_port.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentconnection_ip_port is null-pointer.

◆ ta_terminal_settings_get_connection_ip_string()

ta_e_result_code_t ta_terminal_settings_get_connection_ip_string ( ta_object_t  settings,
ta_object_t connection_ip_string 
)

IP address of the EFT terminal in case of ConnectionMode OnFixIP.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]connection_ip_stringPointer to variable to write object instance to. Object instance is of type string and is not retained. in settings.
Return values
ta_c_rc_okObject instance written to connection_ip_string.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentconnection_ip_string is null-pointer.

◆ ta_terminal_settings_get_connection_mode()

ta_e_result_code_t ta_terminal_settings_get_connection_mode ( ta_object_t  settings,
ta_e_connection_mode_t connection_mode 
)

Broadcast (default) or OnFixIP.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]connection_modePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to connection_mode.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentconnection_mode is null-pointer.

◆ ta_terminal_settings_get_guides()

ta_e_result_code_t ta_terminal_settings_get_guides ( ta_object_t  settings,
int *  guides 
)

Required guides.

Login succeeds only if the terminal is able to provide all requested guides.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]guidesPointer to variable to write value to. OR combination of values from ta_e_guides_t.
Return values
ta_c_rc_okObject instance written to guides.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentguides is null-pointer.

◆ ta_terminal_settings_get_integrator_id()

ta_e_result_code_t ta_terminal_settings_get_integrator_id ( ta_object_t  settings,
ta_object_t integrator_id 
)

Integrator identifier.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]integrator_idPointer to variable to write object instance to. Object instance is of type string and is not retained. in settings.
Return values
ta_c_rc_okObject instance written to integrator_id.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentintegrator_id is null-pointer.

◆ ta_terminal_settings_get_log_dir()

ta_e_result_code_t ta_terminal_settings_get_log_dir ( ta_object_t  settings,
ta_object_t log_dir 
)

Deprecated: Defines where the Log File has to be generated.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[out]log_dirPointer to variable to write object instance to. Object instance is of type string and is not retained. in settings.
Return values
ta_c_rc_okObject instance written to log_dir.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentlog_dir is null-pointer.

◆ ta_terminal_settings_get_log_file_count_per_archive()

ta_e_result_code_t ta_terminal_settings_get_log_file_count_per_archive ( ta_object_t  settings,
int *  file_count_per_archive 
)

Deprecated: Number of log files to keep before per archive file.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[out]file_count_per_archivePointer to variable to write value to.
Return values
ta_c_rc_okValue written to file_count_per_archive.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentfile_count_per_archive is null-pointer.

◆ ta_terminal_settings_get_log_retain_archive_count()

ta_e_result_code_t ta_terminal_settings_get_log_retain_archive_count ( ta_object_t  settings,
int *  archive_count 
)

Deprecated: Number of log file archives to keep before deleting them.

0 to disable using archive files.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[out]archive_countPointer to variable to write value to.
Return values
ta_c_rc_okValue written to archive_count.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentarchive_count is null-pointer.

◆ ta_terminal_settings_get_log_retain_file_count()

ta_e_result_code_t ta_terminal_settings_get_log_retain_file_count ( ta_object_t  settings,
int *  file_count 
)

Deprecated: Number of log files to keep before archiving them.

0 to disable using log files.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[out]file_countPointer to variable to write value to.
Return values
ta_c_rc_okValue written to file_count.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentfile_count is null-pointer.

◆ ta_terminal_settings_get_manufacturer_flags()

ta_e_result_code_t ta_terminal_settings_get_manufacturer_flags ( ta_object_t  settings,
int *  manufacturer_flags 
)

Manufacturer flags.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]manufacturer_flagsPointer to variable to write value to.
Return values
ta_c_rc_okValue written to manufacturer_flags.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentmanufacturer_flags is null-pointer.

◆ ta_terminal_settings_get_persistent_state()

ta_e_result_code_t ta_terminal_settings_get_persistent_state ( ta_object_t  settings,
ta_e_boolean_t persistent_state 
)

Enable persistent state if supported.

Default is false.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]persistent_statePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to persistent_state.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentpersistent_state is null-pointer.

◆ ta_terminal_settings_get_proceed_timeout()

ta_e_result_code_t ta_terminal_settings_get_proceed_timeout ( ta_object_t  settings,
int *  proceed_timeout 
)

Timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]proceed_timeoutPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to proceed_timeout.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentproceed_timeout is null-pointer.

◆ ta_terminal_settings_get_protocol_type()

ta_e_result_code_t ta_terminal_settings_get_protocol_type ( ta_object_t  settings,
ta_e_protocol_type_t protocol_type 
)

Protocol type.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]protocol_typePointer to variable to write value to.
Return values
ta_c_rc_okValue written to protocol_type.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentprotocol_type is null-pointer.

◆ ta_terminal_settings_get_request_repetition()

ta_e_result_code_t ta_terminal_settings_get_request_repetition ( ta_object_t  settings,
int *  request_repetition 
)

Number of send request repetitions or 0 to disable.

Default is 0. Affects these functions:

  • Commit
  • Rollback
Parameters
[in]settingsObject instance of type terminal_settings.
[out]request_repetitionPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to request_repetition.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentrequest_repetition is null-pointer.

◆ ta_terminal_settings_get_saferpay_base_url()

ta_e_result_code_t ta_terminal_settings_get_saferpay_base_url ( ta_object_t  settings,
ta_object_t base_url 
)

Saferpay: Base URL.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]base_urlPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in settings.
Return values
ta_c_rc_okObject instance written to base_url.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_get_saferpay_credentials()

ta_e_result_code_t ta_terminal_settings_get_saferpay_credentials ( ta_object_t  settings,
ta_object_t credentials 
)

Saferpay: Base64 encoded user name + password.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]credentialsPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in settings.
Return values
ta_c_rc_okObject instance written to credentials.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_get_saferpay_customer_id()

ta_e_result_code_t ta_terminal_settings_get_saferpay_customer_id ( ta_object_t  settings,
ta_object_t customer_id 
)

Saferpay: Customer ID.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]customer_idPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in settings.
Return values
ta_c_rc_okObject instance written to customer_id.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_get_saferpay_terminal_id()

ta_e_result_code_t ta_terminal_settings_get_saferpay_terminal_id ( ta_object_t  settings,
ta_object_t terminal_id 
)

Saferpay: Terminal Id.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]terminal_idPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in settings.
Return values
ta_c_rc_okObject instance written to terminal_id.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_get_terminal_id()

ta_e_result_code_t ta_terminal_settings_get_terminal_id ( ta_object_t  settings,
ta_object_t terminal_id 
)

Terminal ID to be broadcasted in case of ConnectionMode Broadcast.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]terminal_idPointer to variable to write object instance to. Object instance is of type string and is not retained. in settings.
Return values
ta_c_rc_okObject instance written to terminal_id.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentterminal_id is null-pointer.

◆ ta_terminal_settings_is_allow_closed_card_insert()

ta_e_result_code_t ta_terminal_settings_is_allow_closed_card_insert ( ta_object_t  settings,
ta_e_boolean_t is_allow_closed_card_insert 
)

Allow card to be inserted before activation.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_allow_closed_card_insertPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_allow_closed_card_insert.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_allow_closed_card_insert is null-pointer.

◆ ta_terminal_settings_is_auto_commit()

ta_e_result_code_t ta_terminal_settings_is_auto_commit ( ta_object_t  settings,
ta_e_boolean_t is_auto_commit 
)

After executing the Transaction- function the API commits the transaction automatically.

If ta_c_b_undefined uses ta_c_b_true/ta_c_b_false depending on the other settings, namely:

  • If Unattended Guide is enabled: ta_c_b_false
  • Otherwise: ta_c_b_true
Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_auto_commitPointer to variable to write value to.
Return values
ta_c_rc_okValue written to is_auto_commit.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_auto_commit is null-pointer.

◆ ta_terminal_settings_is_auto_shift_management()

ta_e_result_code_t ta_terminal_settings_is_auto_shift_management ( ta_object_t  settings,
ta_e_boolean_t is_auto_shift_management 
)

Shift management is handled automatically.

Required if device does not support Activate and Deactivate functions.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_auto_shift_managementPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_auto_shift_management.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_auto_shift_management is null-pointer.

◆ ta_terminal_settings_is_auto_shutter_management()

ta_e_result_code_t ta_terminal_settings_is_auto_shutter_management ( ta_object_t  settings,
ta_e_boolean_t is_auto_shutter_management 
)

Shutter management is handled automatically.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_auto_shutter_managementPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_auto_shutter_management.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_auto_shutter_management is null-pointer.

◆ ta_terminal_settings_is_dcc()

ta_e_result_code_t ta_terminal_settings_is_dcc ( ta_object_t  settings,
ta_e_boolean_t is_dcc 
)

Dcc shall be supported.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_dccPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_dcc.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_dcc is null-pointer.

◆ ta_terminal_settings_is_enabled_keep_alive()

ta_e_result_code_t ta_terminal_settings_is_enabled_keep_alive ( ta_object_t  settings,
ta_e_boolean_t is_enabled_keep_alive 
)

Keep-Alive handling is enabled.

Default is true.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_enabled_keep_alivePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_enabled_keep_alive.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_enabled_keep_alive is null-pointer.

◆ ta_terminal_settings_is_fast_ntf_mode()

ta_e_result_code_t ta_terminal_settings_is_fast_ntf_mode ( ta_object_t  settings,
ta_e_boolean_t is_fast_ntf_mode 
)

Enable fast notification mode.

This parameter is only used if austrian use cases guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_fast_ntf_modePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_fast_ntf_mode.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_fast_ntf_mode is null-pointer.

◆ ta_terminal_settings_is_fetch_brands()

ta_e_result_code_t ta_terminal_settings_is_fetch_brands ( ta_object_t  settings,
ta_e_boolean_t is_fetch_brands 
)

Automatically retrieves application information during logging in.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_fetch_brandsPointer to variable to write value to.
Return values
ta_c_rc_okValue written to is_fetch_brands.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_fetch_brands is null-pointer.

◆ ta_terminal_settings_is_partial_approval()

ta_e_result_code_t ta_terminal_settings_is_partial_approval ( ta_object_t  settings,
ta_e_boolean_t is_partial_approval 
)

Partial approval shall be supported.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_partial_approvalPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_partial_approval.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_partial_approval is null-pointer.

◆ ta_terminal_settings_is_tip_allowed()

ta_e_result_code_t ta_terminal_settings_is_tip_allowed ( ta_object_t  settings,
ta_e_boolean_t is_tip_allowed 
)

Tip is allowed for purchase transactions.

This parameter is only used if gastro guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]is_tip_allowedPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_tip_allowed.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_tip_allowed is null-pointer.

◆ ta_terminal_settings_late_checkin_timeout()

ta_e_result_code_t ta_terminal_settings_late_checkin_timeout ( ta_object_t  settings,
int *  timeout 
)

This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.

This parameter is only used if value added services guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[out]timeoutPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to is_fast_ntf_mode.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentis_fast_ntf_mode is null-pointer.

◆ ta_terminal_settings_set_allow_closed_card_insert()

ta_e_result_code_t ta_terminal_settings_set_allow_closed_card_insert ( ta_object_t  settings,
ta_e_boolean_t  allow_closed_card_insert 
)

Set allow card to be inserted before activation.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]allow_closed_card_insertValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_auto_commit()

ta_e_result_code_t ta_terminal_settings_set_auto_commit ( ta_object_t  settings,
ta_e_boolean_t  auto_commit 
)

After executing the Transaction- function the API commits the transaction automatically.

If auto_commit is ta_c_b_undefined uses ta_c_b_true/ta_c_b_false depending on the other settings, namely:

  • If Unattended Guide is enabled: ta_c_b_false
  • Otherwise: ta_c_b_true
Parameters
[in]settingsObject instance of type terminal_settings.
[in]auto_commitValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_auto_shift_management()

ta_e_result_code_t ta_terminal_settings_set_auto_shift_management ( ta_object_t  settings,
ta_e_boolean_t  auto_shift_management 
)

Shift management is handled automatically.

Required if device does not support Activate and Deactivate functions.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]auto_shift_managementValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_auto_shutter_management()

ta_e_result_code_t ta_terminal_settings_set_auto_shutter_management ( ta_object_t  settings,
ta_e_boolean_t  auto_shutter_management 
)

Shutter management is handled automatically.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]auto_shutter_managementValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_broadcast_interface()

ta_e_result_code_t ta_terminal_settings_set_broadcast_interface ( ta_object_t  settings,
ta_object_t  broadcast_interface 
)

Set Interface to use for broadcasting or empty string to broadcast on all available interfaces.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]broadcast_interfaceObject instance to set. Object instance has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentbroadcast_interface is ta_invalid_object.
ta_c_rc_invalid_argumentbroadcast_interface is not of type string.

◆ ta_terminal_settings_set_card_insertion_timeout()

ta_e_result_code_t ta_terminal_settings_set_card_insertion_timeout ( ta_object_t  settings,
int  card_insertion_timeout 
)

Timeout in seconds the terminal waits for a card to be inserted before canceling an open transaction request.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]card_insertion_timeoutValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcard_insertion_timeout is less than 0.

◆ ta_terminal_settings_set_card_removal_timeout()

ta_e_result_code_t ta_terminal_settings_set_card_removal_timeout ( ta_object_t  settings,
int  card_removal_timeout 
)

Timeout in seconds the terminal waits for a card to be removed before requesting attendant interaction.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]card_removal_timeoutValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcard_removal_timeout is less than 0.

◆ ta_terminal_settings_set_commit_timeout()

ta_e_result_code_t ta_terminal_settings_set_commit_timeout ( ta_object_t  settings,
int  commit_timeout 
)

Timeout in seconds the terminal waits until the technical auto-reversal is processed, if no commit received.

Timer starts with response and is reset in case client enters information in the terminal.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]commit_timeoutValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcommit_timeout is less than 0.

◆ ta_terminal_settings_set_connection_ip_port()

ta_e_result_code_t ta_terminal_settings_set_connection_ip_port ( ta_object_t  settings,
int  connection_ip_port 
)

Listening Port of the EFT terminal in case of ConnectionMode OnFixIP.

Parameters
[in]settingsValue of type terminal_settings.
[in]connection_ip_portValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_connection_ip_string()

ta_e_result_code_t ta_terminal_settings_set_connection_ip_string ( ta_object_t  settings,
ta_object_t  connection_ip_string 
)

Set IP address of the EFT terminal in case of ConnectionMode OnFixIP.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]connection_ip_stringObject instance to set. Object instance has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentconnection_ip_string is not of type string.

◆ ta_terminal_settings_set_connection_mode()

ta_e_result_code_t ta_terminal_settings_set_connection_mode ( ta_object_t  settings,
ta_e_connection_mode_t  connection_mode 
)

Set broadcast (default) or OnFixIP.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]connection_modeValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_dcc()

ta_e_result_code_t ta_terminal_settings_set_dcc ( ta_object_t  settings,
ta_e_boolean_t  dcc 
)

Set if Dcc shall be supported.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]dccValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_enabled_keep_alive()

ta_e_result_code_t ta_terminal_settings_set_enabled_keep_alive ( ta_object_t  settings,
ta_e_boolean_t  enabled_keep_alive 
)

Set Keep-Alive handling is enabled.

Default is true.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]enabled_keep_aliveValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentenabled_keep_alive is less than 0.

◆ ta_terminal_settings_set_fast_ntf_mode()

ta_e_result_code_t ta_terminal_settings_set_fast_ntf_mode ( ta_object_t  settings,
ta_e_boolean_t  fast_ntf_mode 
)

Set enable fast notification mode.

This parameter is only used if austrian use cases guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]fast_ntf_modeValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_fetch_brands()

ta_e_result_code_t ta_terminal_settings_set_fetch_brands ( ta_object_t  settings,
ta_e_boolean_t  fetch_brands 
)

Automatically retrieves application information during logging in.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]fetch_brandsValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_guides()

ta_e_result_code_t ta_terminal_settings_set_guides ( ta_object_t  settings,
int  guides 
)

Required guides.

Login succeeds only if the terminal is able to provide all requested guides.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]guidesValue to set. OR combination of values from ta_e_guides_t.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_integrator_id()

ta_e_result_code_t ta_terminal_settings_set_integrator_id ( ta_object_t  settings,
ta_object_t  integrator_id 
)

Set integrator identifier.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]integrator_idObject instance to set. Object instance has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentintegrator_id is ta_invalid_object.
ta_c_rc_invalid_argumentintegrator_id is not of type string.

◆ ta_terminal_settings_set_late_checkin_timeout()

ta_e_result_code_t ta_terminal_settings_set_late_checkin_timeout ( ta_object_t  settings,
int  timeout 
)

This timeout indicates how long a terminal shall wait in seconds for an AmtAdjustment notification from the ECR in case of a late-checkin.

This parameter is only used if value added services guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]timeoutValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_log_dir()

ta_e_result_code_t ta_terminal_settings_set_log_dir ( ta_object_t  settings,
ta_object_t  log_dir 
)

Deprecated: Set where the Log File has to be generated.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]log_dirObject instance to set. Object instance has to be of type string.
Deprecated:
Can not be used.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentlog_dir is ta_invalid_object.
ta_c_rc_invalid_argumentlog_dir is not of type string.

◆ ta_terminal_settings_set_log_file_count_per_archive()

ta_e_result_code_t ta_terminal_settings_set_log_file_count_per_archive ( ta_object_t  settings,
int  log_file_count_per_archive 
)

Deprecated: Set number of log files to keep before per archive file.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[in]log_file_count_per_archiveValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentlog_file_count_per_archive is less than 0.

◆ ta_terminal_settings_set_log_retain_archive_count()

ta_e_result_code_t ta_terminal_settings_set_log_retain_archive_count ( ta_object_t  settings,
int  log_retain_archive_count 
)

Deprecated: Set number of log file archives to keep before deleting them.

0 to disable using archive files.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[in]log_retain_archive_countValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentlog_retain_archive_count is less than 0.

◆ ta_terminal_settings_set_log_retain_file_count()

ta_e_result_code_t ta_terminal_settings_set_log_retain_file_count ( ta_object_t  settings,
int  retain_file_count 
)

Deprecated: Set number of log files to keep before archiving them.

0 to disable using log files.

Deprecated:
Can not be used.
Parameters
[in]settingsObject instance of type terminal_settings.
[in]retain_file_countValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentretain_file_count is less than 0.

◆ ta_terminal_settings_set_manufacturer_flags()

ta_e_result_code_t ta_terminal_settings_set_manufacturer_flags ( ta_object_t  settings,
int  manufacturer_flags 
)

Set manufacturer flags.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]manufacturer_flagsValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_partial_approval()

ta_e_result_code_t ta_terminal_settings_set_partial_approval ( ta_object_t  settings,
ta_e_boolean_t  partial_approval 
)

Set if partial approval shall be supported.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]partial_approvalValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_persistent_state()

ta_e_result_code_t ta_terminal_settings_set_persistent_state ( ta_object_t  settings,
ta_e_boolean_t  persistent_state 
)

Set Enable persistent state if supported.

Default is false.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]persistent_stateValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentpersistent_state is less than 0.

◆ ta_terminal_settings_set_proceed_timeout()

ta_e_result_code_t ta_terminal_settings_set_proceed_timeout ( ta_object_t  settings,
int  proceed_timeout 
)

Set timeout in seconds the terminal waits in WaitForProceed state for an additional function until an error is returned.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]proceed_timeoutValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentproceed_timeout is less than 0.

◆ ta_terminal_settings_set_protocol_type()

ta_e_result_code_t ta_terminal_settings_set_protocol_type ( ta_object_t  settings,
ta_e_protocol_type_t  protocol_type 
)

Set protocol type.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]protocol_typeValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.

◆ ta_terminal_settings_set_request_repetition()

ta_e_result_code_t ta_terminal_settings_set_request_repetition ( ta_object_t  settings,
int  request_repetition 
)

Set number of send request repetitions or 0 to disable.

Default is 0. Affects these functions:

  • Commit
  • Rollback
Parameters
[in]settingsObject instance of type terminal_settings.
[in]request_repetitionValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentrequest_repetition is less than 0.

◆ ta_terminal_settings_set_saferpay_base_url()

ta_e_result_code_t ta_terminal_settings_set_saferpay_base_url ( ta_object_t  settings,
ta_object_t  base_url 
)

Saferpay: Base URL.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]base_urlObject instance to set.Object instance can be ta_invalid_object to clear the value in settings. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentbase_url is ta_invalid_object.
ta_c_rc_invalid_argumentbase_url is not ta_invalid_object and is not of type string.

◆ ta_terminal_settings_set_saferpay_credentials()

ta_e_result_code_t ta_terminal_settings_set_saferpay_credentials ( ta_object_t  settings,
ta_object_t  credentials 
)

Saferpay: Base64 encoded user name + password.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]credentialsObject instance to set.Object instance can be ta_invalid_object to clear the value in settings. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcredentials is ta_invalid_object.
ta_c_rc_invalid_argumentcredentials is not ta_invalid_object and is not of type string.

◆ ta_terminal_settings_set_saferpay_customer_id()

ta_e_result_code_t ta_terminal_settings_set_saferpay_customer_id ( ta_object_t  settings,
ta_object_t  customer_id 
)

Saferpay: Customer ID.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]customer_idObject instance to set.Object instance can be ta_invalid_object to clear the value in settings. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentcustomer_id is ta_invalid_object.
ta_c_rc_invalid_argumentcustomer_id is not ta_invalid_object and is not of type string.

◆ ta_terminal_settings_set_saferpay_terminal_id()

ta_e_result_code_t ta_terminal_settings_set_saferpay_terminal_id ( ta_object_t  settings,
ta_object_t  terminal_id 
)

Set saferpay: Terminal Id.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]terminal_idObject instance to set.Object instance can be ta_invalid_object to clear the value in settings. If object instance is not ta_invalid_object is has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentterminal_id is ta_invalid_object.
ta_c_rc_invalid_argumentterminal_id is not ta_invalid_object and is not of type string.

◆ ta_terminal_settings_set_terminal_id()

ta_e_result_code_t ta_terminal_settings_set_terminal_id ( ta_object_t  settings,
ta_object_t  terminal_id 
)

Set terminal ID to be broadcasted in case of ConnectionMode Broadcast.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]terminal_idObject instance to set. Object instance has to be of type string.
Return values
ta_c_rc_okObject instance assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.
ta_c_rc_invalid_argumentterminal_id is ta_invalid_object.
ta_c_rc_invalid_argumentterminal_id is not of type string.

◆ ta_terminal_settings_set_tip_allowed()

ta_e_result_code_t ta_terminal_settings_set_tip_allowed ( ta_object_t  settings,
ta_e_boolean_t  tip_allowed 
)

Set tip is allowed for purchase transactions.

This parameter is only used if gastro guide is enabled.

Parameters
[in]settingsObject instance of type terminal_settings.
[in]tip_allowedValue to set.
Return values
ta_c_rc_okValue assigned to settings.
ta_c_rc_invalid_argumentsettings is ta_invalid_object.
ta_c_rc_invalid_argumentsettings is not of type terminal_settings.