TIM SDK
TIM API C
|
|
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... | |
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.
[out] | settings | Pointer to variable to write created object instance to. Created object instance is retained. |
ta_c_rc_ok | Object instance has been created and written to settings. |
ta_c_rc_invalid_argument | settings is null-pointer. |
ta_c_rc_out_of_memory | Failed allocating memory. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | broadcast_interface | Pointer to variable to write object instance to. Object instance is of type string and is not retained. in settings. |
ta_c_rc_ok | Object instance written to broadcast_interface. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | broadcast_interface is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | card_insertion_timeout | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to card_insertion_timeout. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | card_insertion_timeout is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | card_removal_timeout | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to card_removal_timeout. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | card_removal_timeout is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | commit_timeout | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to commit_timeout. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | commit_timeout is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | connection_ip_port | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to connection_ip_port. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | connection_ip_port is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | connection_ip_string | Pointer to variable to write object instance to. Object instance is of type string and is not retained. in settings. |
ta_c_rc_ok | Object instance written to connection_ip_string. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | connection_ip_string is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | connection_mode | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to connection_mode. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | connection_mode is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | guides | Pointer to variable to write value to. OR combination of values from ta_e_guides_t. |
ta_c_rc_ok | Object instance written to guides. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | guides is null-pointer. |
ta_e_result_code_t ta_terminal_settings_get_integrator_id | ( | ta_object_t | settings, |
ta_object_t * | integrator_id | ||
) |
Integrator identifier.
[in] | settings | Object instance of type terminal_settings. |
[out] | integrator_id | Pointer to variable to write object instance to. Object instance is of type string and is not retained. in settings. |
ta_c_rc_ok | Object instance written to integrator_id. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | integrator_id is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | log_dir | Pointer to variable to write object instance to. Object instance is of type string and is not retained. in settings. |
ta_c_rc_ok | Object instance written to log_dir. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | log_dir is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | file_count_per_archive | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to file_count_per_archive. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | file_count_per_archive is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | archive_count | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to archive_count. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | archive_count is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | file_count | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to file_count. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | file_count is null-pointer. |
ta_e_result_code_t ta_terminal_settings_get_manufacturer_flags | ( | ta_object_t | settings, |
int * | manufacturer_flags | ||
) |
Manufacturer flags.
[in] | settings | Object instance of type terminal_settings. |
[out] | manufacturer_flags | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to manufacturer_flags. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | manufacturer_flags is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | persistent_state | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to persistent_state. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | persistent_state is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | proceed_timeout | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to proceed_timeout. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | proceed_timeout is null-pointer. |
ta_e_result_code_t ta_terminal_settings_get_protocol_type | ( | ta_object_t | settings, |
ta_e_protocol_type_t * | protocol_type | ||
) |
Protocol type.
[in] | settings | Object instance of type terminal_settings. |
[out] | protocol_type | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to protocol_type. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | protocol_type is null-pointer. |
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:
[in] | settings | Object instance of type terminal_settings. |
[out] | request_repetition | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to request_repetition. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | request_repetition is null-pointer. |
ta_e_result_code_t ta_terminal_settings_get_saferpay_base_url | ( | ta_object_t | settings, |
ta_object_t * | base_url | ||
) |
Saferpay: Base URL.
[in] | settings | Object instance of type terminal_settings. |
[out] | base_url | Pointer 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. |
ta_c_rc_ok | Object instance written to base_url. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | credentials | Pointer 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. |
ta_c_rc_ok | Object instance written to credentials. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_e_result_code_t ta_terminal_settings_get_saferpay_customer_id | ( | ta_object_t | settings, |
ta_object_t * | customer_id | ||
) |
Saferpay: Customer ID.
[in] | settings | Object instance of type terminal_settings. |
[out] | customer_id | Pointer 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. |
ta_c_rc_ok | Object instance written to customer_id. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_e_result_code_t ta_terminal_settings_get_saferpay_terminal_id | ( | ta_object_t | settings, |
ta_object_t * | terminal_id | ||
) |
Saferpay: Terminal Id.
[in] | settings | Object instance of type terminal_settings. |
[out] | terminal_id | Pointer 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. |
ta_c_rc_ok | Object instance written to terminal_id. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | terminal_id | Pointer to variable to write object instance to. Object instance is of type string and is not retained. in settings. |
ta_c_rc_ok | Object instance written to terminal_id. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | terminal_id is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_allow_closed_card_insert | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_allow_closed_card_insert. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_allow_closed_card_insert is null-pointer. |
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:
[in] | settings | Object instance of type terminal_settings. |
[out] | is_auto_commit | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to is_auto_commit. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_auto_commit is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_auto_shift_management | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_auto_shift_management. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_auto_shift_management is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_auto_shutter_management | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_auto_shutter_management. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_auto_shutter_management is null-pointer. |
ta_e_result_code_t ta_terminal_settings_is_dcc | ( | ta_object_t | settings, |
ta_e_boolean_t * | is_dcc | ||
) |
Dcc shall be supported.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_dcc | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_dcc. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_dcc is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_enabled_keep_alive | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_enabled_keep_alive. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_enabled_keep_alive is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_fast_ntf_mode | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_fast_ntf_mode. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_fast_ntf_mode is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_fetch_brands | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to is_fetch_brands. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_fetch_brands is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_partial_approval | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_partial_approval. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_partial_approval is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | is_tip_allowed | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_tip_allowed. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_tip_allowed is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[out] | timeout | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to is_fast_ntf_mode. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | is_fast_ntf_mode is null-pointer. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | allow_closed_card_insert | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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:
[in] | settings | Object instance of type terminal_settings. |
[in] | auto_commit | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | auto_shift_management | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | auto_shutter_management | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | broadcast_interface | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | broadcast_interface is ta_invalid_object. |
ta_c_rc_invalid_argument | broadcast_interface is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | card_insertion_timeout | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | card_insertion_timeout is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | card_removal_timeout | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | card_removal_timeout is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | commit_timeout | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | commit_timeout is less than 0. |
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.
[in] | settings | Value of type terminal_settings. |
[in] | connection_ip_port | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | connection_ip_string | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | connection_ip_string is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | connection_mode | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | dcc | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | enabled_keep_alive | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | enabled_keep_alive is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | fast_ntf_mode | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | fetch_brands | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | guides | Value to set. OR combination of values from ta_e_guides_t. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_e_result_code_t ta_terminal_settings_set_integrator_id | ( | ta_object_t | settings, |
ta_object_t | integrator_id | ||
) |
Set integrator identifier.
[in] | settings | Object instance of type terminal_settings. |
[in] | integrator_id | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | integrator_id is ta_invalid_object. |
ta_c_rc_invalid_argument | integrator_id is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | timeout | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | log_dir | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | log_dir is ta_invalid_object. |
ta_c_rc_invalid_argument | log_dir is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | log_file_count_per_archive | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | log_file_count_per_archive is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | log_retain_archive_count | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | log_retain_archive_count is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | retain_file_count | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | retain_file_count is less than 0. |
ta_e_result_code_t ta_terminal_settings_set_manufacturer_flags | ( | ta_object_t | settings, |
int | manufacturer_flags | ||
) |
Set manufacturer flags.
[in] | settings | Object instance of type terminal_settings. |
[in] | manufacturer_flags | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | partial_approval | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | persistent_state | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | persistent_state is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | proceed_timeout | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | proceed_timeout is less than 0. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | protocol_type | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
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:
[in] | settings | Object instance of type terminal_settings. |
[in] | request_repetition | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | request_repetition is less than 0. |
ta_e_result_code_t ta_terminal_settings_set_saferpay_base_url | ( | ta_object_t | settings, |
ta_object_t | base_url | ||
) |
Saferpay: Base URL.
[in] | settings | Object instance of type terminal_settings. |
[in] | base_url | Object 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. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | base_url is ta_invalid_object. |
ta_c_rc_invalid_argument | base_url is not ta_invalid_object and is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | credentials | Object 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. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | credentials is ta_invalid_object. |
ta_c_rc_invalid_argument | credentials is not ta_invalid_object and is not of type string. |
ta_e_result_code_t ta_terminal_settings_set_saferpay_customer_id | ( | ta_object_t | settings, |
ta_object_t | customer_id | ||
) |
Saferpay: Customer ID.
[in] | settings | Object instance of type terminal_settings. |
[in] | customer_id | Object 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. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | customer_id is ta_invalid_object. |
ta_c_rc_invalid_argument | customer_id is not ta_invalid_object and is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | terminal_id | Object 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. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | terminal_id is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal_id is not ta_invalid_object and is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | terminal_id | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |
ta_c_rc_invalid_argument | terminal_id is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal_id is not of type string. |
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.
[in] | settings | Object instance of type terminal_settings. |
[in] | tip_allowed | Value to set. |
ta_c_rc_ok | Value assigned to settings. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type terminal_settings. |