TIM SDK
TIM API C
|
|
Terminal.
Object type terminal.
Functions | |
const char * | ta_terminal_get_tim_api_version () |
Tim Api Build Version. | |
ta_e_result_code_t | ta_terminal_create (ta_object_t *terminal, ta_object_t settings) |
Create terminal instance. More... | |
ta_e_result_code_t | ta_terminal_dispose (ta_object_t terminal) |
Dispose of terminal. More... | |
ta_e_result_code_t | ta_terminal_get_settings (ta_object_t terminal, ta_object_t *settings) |
Immutable terminal settings. More... | |
ta_e_result_code_t | ta_terminal_get_terminal_id (ta_object_t terminal, ta_object_t *terminal_id) |
Terminal identifier of connected terminal. More... | |
ta_e_result_code_t | ta_terminal_get_pos_id (ta_object_t terminal, ta_object_t *pos_id) |
POS identifier. More... | |
ta_e_result_code_t | ta_terminal_set_pos_id (ta_object_t terminal, ta_object_t pos_id) |
Set POS identifier. More... | |
ta_e_result_code_t | ta_terminal_get_user_id (ta_object_t terminal, int *user_id) |
User identifier. More... | |
ta_e_result_code_t | ta_terminal_set_user_id (ta_object_t terminal, int user_id) |
Set User identifier. More... | |
ta_e_result_code_t | ta_terminal_get_ecr_data (ta_object_t terminal, ta_object_t *ecr_data) |
ECR Data. More... | |
ta_e_result_code_t | ta_terminal_set_ecr_data (ta_object_t terminal, ta_object_t ecr_data) |
Set ECR Data. More... | |
ta_e_result_code_t | ta_terminal_add_ecr_data (ta_object_t terminal, ta_object_t ecr_info) |
Add ECR data replacing existing one if present. More... | |
ta_e_result_code_t | ta_terminal_get_print_options (ta_object_t terminal, ta_object_t *print_options) |
Print options. More... | |
ta_e_result_code_t | ta_terminal_set_print_options (ta_object_t terminal, ta_object_t print_options) |
Set Print options. More... | |
ta_e_result_code_t | ta_terminal_get_merchant_options (ta_object_t terminal, ta_object_t *merchant_options) |
Merchant options. More... | |
ta_e_result_code_t | ta_terminal_set_merchant_options (ta_object_t terminal, ta_object_t merchant_options) |
Set Merchant options. More... | |
ta_e_result_code_t | ta_terminal_get_customer_data (ta_object_t terminal, ta_object_t *customer_data) |
Customer data. More... | |
ta_e_result_code_t | ta_terminal_set_customer_data (ta_object_t terminal, ta_object_t customer_data) |
Set Customer data. More... | |
ta_e_result_code_t | ta_terminal_get_transaction_data (ta_object_t terminal, ta_object_t *transaction_data) |
Transaction data to use for transaction requests unless set manually. More... | |
ta_e_result_code_t | ta_terminal_set_transaction_data (ta_object_t terminal, ta_object_t transaction_data) |
Set transaction data to use for transaction requests unless set manually. More... | |
ta_e_result_code_t | ta_terminal_get_receipt_formatter (ta_object_t terminal, ta_object_t *receipt_formatter) |
Receipt formatter. More... | |
ta_e_result_code_t | ta_terminal_set_receipt_formatter (ta_object_t terminal, ta_object_t formatter) |
Set receipt formatter. More... | |
ta_e_result_code_t | ta_terminal_get_terminal_status (ta_object_t terminal, ta_object_t *terminal_status) |
Get terminal status. More... | |
ta_e_result_code_t | ta_terminal_get_brands (ta_object_t terminal, ta_object_t *brands) |
Get brands or 0 if not retrieved yet. More... | |
ta_e_result_code_t | ta_terminal_get_features (ta_object_t terminal, ta_s_features_t *features, ta_e_boolean_t *has_features) |
Get features if known. More... | |
ta_e_result_code_t | ta_terminal_get_act_seq_counter (ta_object_t terminal, int *act_seq_counter) |
Activation sequence counter. More... | |
ta_e_result_code_t | ta_terminal_get_config_data (ta_object_t terminal, ta_object_t *config_data) |
Get configuration data. More... | |
ta_e_result_code_t | ta_terminal_activate (ta_object_t terminal, ta_object_t *response) |
Opens a user shift. More... | |
ta_e_result_code_t | ta_terminal_activate_async (ta_object_t terminal) |
Opens a user shift. More... | |
ta_e_result_code_t | ta_terminal_application_information (ta_object_t terminal) |
Requests the list of brands available on the terminal. More... | |
ta_e_result_code_t | ta_terminal_application_information_async (ta_object_t terminal) |
Requests the list of brands available on the terminal. More... | |
ta_e_result_code_t | ta_terminal_balance (ta_object_t terminal, ta_object_t *response) |
Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing. More... | |
ta_e_result_code_t | ta_terminal_balance_async (ta_object_t terminal) |
Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing. More... | |
ta_e_result_code_t | ta_terminal_cancel (ta_object_t terminal) |
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled. More... | |
ta_e_result_code_t | ta_terminal_cancel2 (ta_object_t terminal, ta_e_boolean_t silent, ta_e_boolean_t retain_card) |
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled. More... | |
ta_e_result_code_t | ta_terminal_change_settings (ta_object_t terminal, ta_object_t settings) |
Changes configuration parameters of the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_change_settings_async (ta_object_t terminal, ta_object_t settings) |
Changes configuration parameters of the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_commit (ta_object_t terminal) |
Performs Commit-operation after a successful Transaction call. More... | |
ta_e_result_code_t | ta_terminal_commit_async (ta_object_t terminal) |
Performs Commit-operation after a successful Transaction call. More... | |
ta_e_result_code_t | ta_terminal_commit_amount (ta_object_t terminal, ta_object_t amount, ta_object_t *response) |
Performs Commit-operation after a successful Transaction call. More... | |
ta_e_result_code_t | ta_terminal_commit_amount_async (ta_object_t terminal, ta_object_t amount) |
Performs Commit-operation after a successful Transaction call. More... | |
ta_e_result_code_t | ta_terminal_connect (ta_object_t terminal) |
Initiates a connection to the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_connect_async (ta_object_t terminal) |
Initiates a connection to the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_counter_request (ta_object_t terminal, ta_e_counter_type_t counter_type, ta_object_t *response) |
Get counter information's from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_counter_request_async (ta_object_t terminal, ta_e_counter_type_t counter_type) |
Get counter information's from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_deactivate (ta_object_t terminal, ta_object_t *response) |
Closes a user shift. More... | |
ta_e_result_code_t | ta_terminal_deactivate_async (ta_object_t terminal) |
Closes a user shift. More... | |
ta_e_result_code_t | ta_terminal_disconnect (ta_object_t terminal) |
Interrupts the connection to the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_disconnect_async (ta_object_t terminal) |
Interrupts the connection to the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_dcc_rates (ta_object_t terminal, ta_object_t *response) |
Requests DCC rates from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_dcc_rates_async (ta_object_t terminal) |
Requests DCC rates from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_hardware_information (ta_object_t terminal, ta_object_t *response) |
Get hardware information from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_hardware_information_async (ta_object_t terminal) |
Get hardware information from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_init_transaction (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_object_t *response) |
Initialize a transaction knowing the amount or the card type. More... | |
ta_e_result_code_t | ta_terminal_init_transaction2 (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_e_function_hint_t function_hint, ta_object_t *response) |
Initialize a transaction knowing the amount or the card type. More... | |
ta_e_result_code_t | ta_terminal_init_transaction_async (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount) |
Initialize a transaction knowing the amount or the card type. More... | |
ta_e_result_code_t | ta_terminal_init_transaction2_async (ta_object_t terminal, ta_e_boolean_t display_amount, ta_object_t amount, ta_e_function_hint_t function_hint) |
Initialize a transaction knowing the amount or the card type. More... | |
ta_e_result_code_t | ta_terminal_login (ta_object_t terminal) |
Activate a communication session between the ECR and the terminal. More... | |
ta_e_result_code_t | ta_terminal_login_async (ta_object_t terminal) |
Activate a communication session between the ECR and the terminal. More... | |
ta_e_result_code_t | ta_terminal_logout (ta_object_t terminal) |
Terminates an active communication session between the ECR and the terminal. More... | |
ta_e_result_code_t | ta_terminal_logout_async (ta_object_t terminal) |
Terminates an active communication session between the ECR and the terminal. More... | |
ta_e_result_code_t | ta_terminal_reboot (ta_object_t terminal) |
Force the EFT Terminal to reboot. More... | |
ta_e_result_code_t | ta_terminal_reboot_async (ta_object_t terminal) |
Force the EFT Terminal to reboot. More... | |
ta_e_result_code_t | ta_terminal_reconciliation (ta_object_t terminal, ta_object_t *response) |
Force the EFT Terminal to transmit all financial transactions to the host system. More... | |
ta_e_result_code_t | ta_terminal_reconciliation_async (ta_object_t terminal) |
Force the EFT Terminal to transmit all financial transactions to the host system. More... | |
ta_e_result_code_t | ta_terminal_reconciliation2 (ta_object_t terminal, ta_e_reconciliation_mode_t reconciliation_mode, ta_object_t *response) |
Force the EFT Terminal to transmit all financial transactions to the host system. More... | |
ta_e_result_code_t | ta_terminal_reconciliation2_async (ta_object_t terminal, ta_e_reconciliation_mode_t reconciliation_mode) |
Force the EFT Terminal to transmit all financial transactions to the host system. More... | |
ta_e_result_code_t | ta_terminal_receipt_request (ta_object_t terminal, ta_e_receipt_request_type_t type, ta_object_t *response) |
Receive the latest receipt or a list of silent receipts. More... | |
ta_e_result_code_t | ta_terminal_receipt_request_async (ta_object_t terminal, ta_e_receipt_request_type_t type) |
Receive the latest receipt or a list of silent receipts. More... | |
ta_e_result_code_t | ta_terminal_reconfig (ta_object_t terminal, ta_object_t *response) |
Force the EFT Terminal to get the configuration from the service center. More... | |
ta_e_result_code_t | ta_terminal_reconfig_async (ta_object_t terminal) |
Force the EFT Terminal to get the configuration from the service center. More... | |
ta_e_result_code_t | ta_terminal_rollback (ta_object_t terminal, ta_object_t *response) |
Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. More... | |
ta_e_result_code_t | ta_terminal_rollback_async (ta_object_t terminal) |
Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization. More... | |
ta_e_result_code_t | ta_terminal_software_update (ta_object_t terminal, ta_e_update_status_t *response) |
Force the EFT Terminal to start a Software Update. More... | |
ta_e_result_code_t | ta_terminal_software_update_async (ta_object_t terminal) |
Force the EFT Terminal to start a Software Update. More... | |
ta_e_result_code_t | ta_terminal_system_information (ta_object_t terminal, ta_object_t *response) |
Request system information from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_system_information_async (ta_object_t terminal) |
Request system information from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_transaction (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t *response) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction2 (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t request, ta_object_t *response) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction2_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t request) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction_tip (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_tip, ta_object_t *response) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction_tip_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_tip) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction_cashback (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_cashback, ta_object_t *response) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_transaction_cashback_async (ta_object_t terminal, ta_e_transaction_type_t type, ta_object_t amount, ta_object_t amount_cashback) |
Starts an EFT Terminal Transaction. More... | |
ta_e_result_code_t | ta_terminal_close_reader (ta_object_t terminal) |
Close the shutter of the card reader. More... | |
ta_e_result_code_t | ta_terminal_close_reader_async (ta_object_t terminal) |
Close the shutter of the card reader. More... | |
ta_e_result_code_t | ta_terminal_open_reader (ta_object_t terminal) |
Open the shutter of the card reader. More... | |
ta_e_result_code_t | ta_terminal_open_reader_async (ta_object_t terminal) |
Open the shutter of the card reader. More... | |
ta_e_result_code_t | ta_terminal_eject_card (ta_object_t terminal) |
Eject a card from the card reader. More... | |
ta_e_result_code_t | ta_terminal_eject_card_async (ta_object_t terminal) |
Eject a card from the card reader. More... | |
ta_e_result_code_t | ta_terminal_open_maintenance_window (ta_object_t terminal) |
Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More... | |
ta_e_result_code_t | ta_terminal_open_maintenance_window_async (ta_object_t terminal) |
Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More... | |
ta_e_result_code_t | ta_terminal_close_maintenance_window (ta_object_t terminal) |
Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More... | |
ta_e_result_code_t | ta_terminal_close_maintenance_window_async (ta_object_t terminal) |
Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR. More... | |
ta_e_result_code_t | ta_terminal_hold_commit (ta_object_t terminal) |
Extends the Commit timeout if the terminal needs additional time before the Commit shall be performed. More... | |
ta_e_result_code_t | ta_terminal_activate_service_menu (ta_object_t terminal) |
Activate service menu. More... | |
ta_e_result_code_t | ta_terminal_activate_service_menu_async (ta_object_t terminal) |
Activate service menu. More... | |
ta_e_result_code_t | ta_terminal_amt_adjustment (ta_object_t terminal, ta_object_t amount) |
Dynamically adjusts the transaction amount of an already running transaction. More... | |
ta_e_result_code_t | ta_terminal_amt_adjustment_2 (ta_object_t terminal, ta_object_t amount, ta_object_t amount_discount, ta_object_t loyalty_coupon_list, ta_object_t loyalty_information_list) |
Dynamically adjusts the transaction amount of an already running transaction. More... | |
ta_e_result_code_t | ta_terminal_loyalty_data (ta_object_t terminal, ta_e_loyalty_function_type_t function_type, ta_object_t data_type, ta_object_t data, ta_e_boolean_t retain_card, ta_object_t *response) |
This function is used to query and configure loyalty information. More... | |
ta_e_result_code_t | ta_terminal_loyalty_data_async (ta_object_t terminal, ta_e_loyalty_function_type_t function_type, ta_object_t data_type, ta_object_t data, ta_e_boolean_t retain_card) |
This function is used to query and configure loyalty information. More... | |
ta_e_result_code_t | ta_terminal_start_checkout (ta_object_t terminal) |
This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started. More... | |
ta_e_result_code_t | ta_terminal_start_checkout_async (ta_object_t terminal) |
This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started. More... | |
ta_e_result_code_t | ta_terminal_finish_checkout (ta_object_t terminal, ta_object_t *response) |
This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process. More... | |
ta_e_result_code_t | ta_terminal_finish_checkout_async (ta_object_t terminal) |
This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process. More... | |
ta_e_result_code_t | ta_terminal_provide_loyalty_basket (ta_object_t terminal, ta_object_t basket, ta_object_t *response) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More... | |
ta_e_result_code_t | ta_terminal_provide_loyalty_basket_async (ta_object_t terminal, ta_object_t basket) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More... | |
ta_e_result_code_t | ta_terminal_provide_vas_result (ta_object_t terminal, ta_object_t result, ta_object_t *response) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More... | |
ta_e_result_code_t | ta_terminal_provide_vas_result_async (ta_object_t terminal, ta_object_t result) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it. More... | |
ta_e_result_code_t | ta_terminal_open_dialog_mode (ta_object_t terminal) |
Open dialog mode on the terminal. More... | |
ta_e_result_code_t | ta_terminal_open_dialog_mode_async (ta_object_t terminal) |
Open dialog mode on the terminal. More... | |
ta_e_result_code_t | ta_terminal_close_dialog_mode (ta_object_t terminal) |
Close dialog mode on the terminal. More... | |
ta_e_result_code_t | ta_terminal_close_dialog_mode_async (ta_object_t terminal) |
Close dialog mode on the terminal. More... | |
ta_e_result_code_t | ta_terminal_show_signature_capture (ta_object_t terminal, ta_object_t request, ta_object_t *response) |
Show signature capture on the terminal. More... | |
ta_e_result_code_t | ta_terminal_show_signature_capture_async (ta_object_t terminal, ta_object_t request) |
Request system information from the EFT Terminal. More... | |
ta_e_result_code_t | ta_terminal_show_dialog (ta_object_t terminal, ta_object_t request, ta_object_t *response) |
Show dialog on the terminal. More... | |
ta_e_result_code_t | ta_terminal_show_dialog_async (ta_object_t terminal, ta_object_t request) |
Show dialog on the terminal. More... | |
ta_e_result_code_t | ta_terminal_print_on_terminal (ta_object_t terminal, ta_object_t ticket_data) |
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. More... | |
ta_e_result_code_t | ta_terminal_print_on_terminal_async (ta_object_t terminal, ta_object_t ticket_data) |
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal. More... | |
ta_e_result_code_t | ta_terminal_send_card_command (ta_object_t terminal, ta_object_t requests, ta_object_t *responses) |
Send card command. More... | |
ta_e_result_code_t | ta_terminal_send_card_command_async (ta_object_t terminal, ta_object_t requests) |
Send card command. More... | |
ta_e_result_code_t | ta_terminal_balance_inquiry (ta_object_t terminal, ta_object_t *response) |
Get information about the current account balance of the inserted card. More... | |
ta_e_result_code_t | ta_terminal_balance_inquiry_async (ta_object_t terminal) |
Get information about the current account balance of the inserted card. More... | |
ta_e_result_code_t | ta_terminal_request_alias (ta_object_t terminal, ta_object_t six_trans_ref, ta_object_t *response) |
The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions. More... | |
ta_e_result_code_t | ta_terminal_request_alias_async (ta_object_t terminal, ta_object_t six_trans_ref) |
The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions. More... | |
ta_e_result_code_t | ta_terminal_can_dcc (ta_object_t terminal, ta_e_boolean_t *result) |
Returns true if at least one payment protocol and the terminal configuration offer DCC i.e. if there is a chance to do a DCC transaction. More... | |
ta_e_result_code_t | ta_terminal_can_declined_receipts (ta_object_t terminal, ta_e_boolean_t *result) |
Support for "Declined Receipts" in at least one payment protocol. More... | |
ta_e_result_code_t | ta_terminal_can_multi_account_selection (ta_object_t terminal, ta_e_boolean_t *result) |
Support for multiple account selection. More... | |
ta_e_result_code_t | ta_terminal_has_sw_update (ta_object_t terminal, ta_e_boolean_t *result) |
Software update is available. More... | |
ta_e_result_code_t | ta_terminal_add_listener (ta_object_t terminal, ta_object_t listener) |
Register listener. More... | |
ta_e_result_code_t | ta_terminal_remove_listener (ta_object_t terminal, ta_object_t listener) |
Unregister listener. More... | |
ta_e_result_code_t | ta_terminal_set_custom_logger (ta_object_t terminal, ta_cb_publish_log_record callback, void *user_pointer) |
Set custom terminal logger callback. More... | |
ta_e_result_code_t ta_terminal_activate | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Opens a user shift.
If the shift is already open, no error is returned.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type activate_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_activate_async | ( | ta_object_t | terminal | ) |
Opens a user shift.
If the shift is already open, no error is returned.
Asynchronous version of ta_terminal_activate. Callback function is ta_cb_terminal_activate_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request send successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_activate_service_menu | ( | ta_object_t | terminal | ) |
ta_e_result_code_t ta_terminal_activate_service_menu_async | ( | ta_object_t | terminal | ) |
Activate service menu.
Asynchronous version of ta_terminal_activate_service_menu. Callback function is ta_cb_terminal_activate_service_menu_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_add_ecr_data | ( | ta_object_t | terminal, |
ta_object_t | ecr_info | ||
) |
Add ECR data replacing existing one if present.
To remove elements use ta_terminal_set_ecr_data instead.
[in] | terminal | Object instance of type terminal. |
[in] | ecr_info | Object instance to add. Object instance has to be of type ecr_info. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | ecr_info is ta_invalid_object. |
ta_c_rc_invalid_argument | ecr_info is not of type ecr_info. |
ta_e_result_code_t ta_terminal_add_listener | ( | ta_object_t | terminal, |
ta_object_t | listener | ||
) |
Register listener.
[in] | terminal | Object instance of type terminal. |
[in] | listener | Object instance of type terminal_listener. |
ta_c_rc_ok | Listener added to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | listener is ta_invalid_object. |
ta_e_result_code_t ta_terminal_amt_adjustment | ( | ta_object_t | terminal, |
ta_object_t | amount | ||
) |
Dynamically adjusts the transaction amount of an already running transaction.
This is a "best effort" function and will be processed as long as the underlaying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.
To be able to validate if this notification has been processed correctly the TerminalStatus-notification must return the current adjusted Amount.
ta_c_rc_ok | Hold commit send to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount. |
ta_e_result_code_t ta_terminal_amt_adjustment_2 | ( | ta_object_t | terminal, |
ta_object_t | amount, | ||
ta_object_t | amount_discount, | ||
ta_object_t | loyalty_coupon_list, | ||
ta_object_t | loyalty_information_list | ||
) |
Dynamically adjusts the transaction amount of an already running transaction.
This is a "best effort" function and will be processed as long as the underlaying payment protocol supports it. The amount transmitted in the notification is the new total amount. The EFT does not calculate amounts, this is the ECRs responsibility.
To be able to validate if this notification has been processed correctly the TerminalStatus-notification must return the current adjusted Amount.
[in] | terminal | Object instance of type terminal. |
[in] | amount | Object instance of type amount. |
[in] | amount_discount | Optional discount amount. If not ta_invalid_object object instance has to be of type amount_discount. |
[in] | loyalty_coupon_list | Optional list of loyalty coupons. If not ta_invalid_object object instance has to be of type list with elements inside have to be of type loyalty_coupon. |
[in] | loyalty_information_list | Optional list of loyalty information. If not ta_invalid_object object instance has to be of type list with elements inside have to be of type loyalty_information. |
ta_c_rc_ok | Hold commit send to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount is not of type amount. |
ta_c_rc_invalid_argument | amount_discount is not ta_invalid_object and is not of type amount_discount. |
ta_c_rc_invalid_argument | loyalty_coupon_list is not ta_invalid_object and not of type list. |
ta_c_rc_invalid_argument | Elements in loyalty_coupon_list are ta_invalid_object. |
ta_c_rc_invalid_argument | Elements in loyalty_coupon_list are not of type loyalty_coupon. |
ta_c_rc_invalid_argument | loyalty_information_list is not ta_invalid_object and not of type list. |
ta_c_rc_invalid_argument | Elements in loyalty_information_list are ta_invalid_object. |
ta_c_rc_invalid_argument | Elements in loyalty_information_list are not of type loyalty_information. |
ta_e_result_code_t ta_terminal_application_information | ( | ta_object_t | terminal | ) |
Requests the list of brands available on the terminal.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_application_information_async | ( | ta_object_t | terminal | ) |
Requests the list of brands available on the terminal.
Asynchronous version of ta_terminal_application_information. Callback function is ta_cb_terminal_application_information_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request send successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_balance | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type balance_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_balance_async | ( | ta_object_t | terminal | ) |
Forces the EFT Terminal to transmit all transactions to the host system as well to do the daily closing.
Asynchronous version of ta_terminal_balance. Callback function is ta_cb_terminal_balance_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request send successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_balance_inquiry | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Get information about the current account balance of the inserted card.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type balance_inquiry_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_balance_inquiry_async | ( | ta_object_t | terminal | ) |
Get information about the current account balance of the inserted card.
Asynchronous version of ta_terminal_balance_inquiry. Callback function is ta_cb_terminal_balance_inquiry_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_can_dcc | ( | ta_object_t | terminal, |
ta_e_boolean_t * | result | ||
) |
Returns true if at least one payment protocol and the terminal configuration offer DCC i.e. if there is a chance to do a DCC transaction.
[in] | terminal | Object instance of type terminal. |
[out] | result | Pointer to variable to write result to. |
ta_c_rc_ok | Result written to result. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | result is null-pointer. |
ta_e_result_code_t ta_terminal_can_declined_receipts | ( | ta_object_t | terminal, |
ta_e_boolean_t * | result | ||
) |
Support for "Declined Receipts" in at least one payment protocol.
[in] | terminal | Object instance of type terminal. |
[out] | result | Pointer to variable to write result to. |
ta_c_rc_ok | Result written to result. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | result is null-pointer. |
ta_e_result_code_t ta_terminal_can_multi_account_selection | ( | ta_object_t | terminal, |
ta_e_boolean_t * | result | ||
) |
Support for multiple account selection.
[in] | terminal | Object instance of type terminal. |
[out] | result | Pointer to variable to write result to. |
ta_c_rc_ok | Result written to result. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | result is null-pointer. |
ta_e_result_code_t ta_terminal_cancel | ( | ta_object_t | terminal | ) |
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled.
Further information: A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be cancelled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the cancelled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.
The Transaction request can only be cancelled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Cancel send to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_cancel2 | ( | ta_object_t | terminal, |
ta_e_boolean_t | silent, | ||
ta_e_boolean_t | retain_card | ||
) |
Aborts an open asynchronous Financial Transaction or Non-Financial Transaction request, except for a ta_terminal_commit or ta_terminal_rollback_async request, which cannot be cancelled.
Further information: A Cancel-request is a best effort request. The EFT Terminal can ignore the Cancel-request if the request in progress is in a state it can not be cancelled. A Cancel-request has no effect if there's no open request of a Financial Transaction or Non-financial Transaction. If the EFT Terminal cancels the request in progress an error response is send back for the cancelled request (see chapter Abort Purchase for an example). Cancel-requests can be send multiple times in an attempt to cancel a request in progress but should be spaced by a few seconds. Cancel-requests themselves are never acknowledged by the EFT Terminal.
The Transaction request can only be cancelled before a Commit has been performed. Also the underlying payment protocol can restrict this functionality.
[in] | terminal | Object instance of type terminal. |
[in] | silent | ta_c_b_true to not show an abort screen otherwise ta_c_b_false. |
[in] | retain_card | ta_c_b_true to not eject card otherwise ta_c_b_false. |
ta_c_rc_ok | Cancel send to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_change_settings | ( | ta_object_t | terminal, |
ta_object_t | settings | ||
) |
Changes configuration parameters of the EFT Terminal.
[in] | terminal | Object instance of type terminal. |
[in] | settings | Object instance with settings. Object instance has to be of type map. Keys in the map have to be of type integer matching ta_e_settings_type_t. Values in the map have to be of type string. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type map. |
ta_c_rc_invalid_argument | Key in settings is ta_invalid_object. |
ta_c_rc_invalid_argument | Key in settings is not of type integer. |
ta_c_rc_invalid_argument | Value in settings is ta_invalid_object. |
ta_c_rc_invalid_argument | Value in settings is not of type string. |
ta_e_result_code_t ta_terminal_change_settings_async | ( | ta_object_t | terminal, |
ta_object_t | settings | ||
) |
Changes configuration parameters of the EFT Terminal.
Asynchronous version of ta_terminal_change_settings. Callback function is ta_cb_terminal_change_settings_completed.
[in] | terminal | Object instance of type terminal. |
[in] | settings | Object instance with settings. Object instance has to be of type map. Keys in the map have to be of type integer matching ta_e_settings_type_t. Values in the map have to be of type string. |
ta_c_rc_ok | Request send successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_invalid_argument | settings is not of type map. |
ta_c_rc_invalid_argument | Key in settings is ta_invalid_object. |
ta_c_rc_invalid_argument | Key in settings is not of type integer. |
ta_c_rc_invalid_argument | Value in settings is ta_invalid_object. |
ta_c_rc_invalid_argument | Value in settings is not of type string. |
ta_e_result_code_t ta_terminal_close_dialog_mode | ( | ta_object_t | terminal | ) |
Close dialog mode on the terminal.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_close_dialog_mode_async | ( | ta_object_t | terminal | ) |
Close dialog mode on the terminal.
Asynchronous version of ta_terminal_close_dialog_mode. Callback function is ta_cb_terminal_close_dialog_mode_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_close_maintenance_window | ( | ta_object_t | terminal | ) |
Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.
The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_close_maintenance_window_async | ( | ta_object_t | terminal | ) |
Closes the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.
The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
Asynchronous version of ta_terminal_close_maintenance_window. Callback function is ta_cb_terminal_close_maintenance_window_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_close_reader | ( | ta_object_t | terminal | ) |
Close the shutter of the card reader.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_close_reader_async | ( | ta_object_t | terminal | ) |
Close the shutter of the card reader.
Asynchronous version of ta_terminal_close_reader. Callback function is ta_cb_terminal_close_reader_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_commit | ( | ta_object_t | terminal | ) |
Performs Commit-operation after a successful Transaction call.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_commit_amount | ( | ta_object_t | terminal, |
ta_object_t | amount, | ||
ta_object_t * | response | ||
) |
Performs Commit-operation after a successful Transaction call.
[in] | terminal | Object instance of type terminal. |
[in] | amount | Object instance of type amount or ta_invalid_object. |
[out] | response | Pointer to write object instance of type print_data. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and object instance is not of type amount. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_commit_amount_async | ( | ta_object_t | terminal, |
ta_object_t | amount | ||
) |
Performs Commit-operation after a successful Transaction call.
Asynchronous version of ta_terminal_commit. Callback function is ta_cb_terminal_commit_completed.
[in] | terminal | Object instance of type terminal. |
[in] | amount | Object instance of type amount or ta_invalid_object. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and object instance is not of type amount. |
ta_e_result_code_t ta_terminal_commit_async | ( | ta_object_t | terminal | ) |
Performs Commit-operation after a successful Transaction call.
Asynchronous version of ta_terminal_commit. Callback function is ta_cb_terminal_commit_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_connect | ( | ta_object_t | terminal | ) |
Initiates a connection to the EFT Terminal.
Calling this function is not needed normally, because all methods make first a connect, if not connected
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Connected to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_connect_async | ( | ta_object_t | terminal | ) |
Initiates a connection to the EFT Terminal.
Calling this function is not needed normally, because all methods make first a connect, if not connected
Asynchronous version of ta_terminal_connect. Callback function is ta_cb_terminal_connect_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Started connecting to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_counter_request | ( | ta_object_t | terminal, |
ta_e_counter_type_t | counter_type, | ||
ta_object_t * | response | ||
) |
Get counter information's from the EFT Terminal.
[in] | terminal | Object instance of type terminal. |
[in] | counter_type | Type of counters to receive. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type counters. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_counter_request_async | ( | ta_object_t | terminal, |
ta_e_counter_type_t | counter_type | ||
) |
Get counter information's from the EFT Terminal.
Asynchronous version of ta_terminal_counter_request. Callback function is ta_cb_terminal_counter_request_completed.
[in] | terminal | Object instance of type terminal. |
[in] | counter_type | Type of counters to receive. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_create | ( | ta_object_t * | terminal, |
ta_object_t | settings | ||
) |
Create terminal instance.
Caller retains a reference to the created instance. Different users can individually retain the terminal instance themselves by calling ta_object_retain. Each call to ta_object_retain and ta_terminal_create has to be matched with a call to ta_object_release. The terminal instance is destroyed once nobody retains the terminal instance anymore.
The provided terminal settings instance is not change nor stored. Instead an immutable copy thereof is stored.
[out] | terminal | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | settings | Object instance of type terminal_settings. Terminal object stores an internal read-only copy of the terminal settings. It is safe to change the object instance after this call without affecting the terminal object. |
ta_c_rc_ok | Object instance has been created and written to terminal. |
ta_c_rc_invalid_argument | terminal is null-pointer. |
ta_c_rc_invalid_argument | settings is ta_invalid_object. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_terminal_dcc_rates | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Requests DCC rates from the EFT Terminal.
The DCC rates are returned as receipt.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type print_data. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_dcc_rates_async | ( | ta_object_t | terminal | ) |
Requests DCC rates from the EFT Terminal.
The DCC rates are returned as receipt.
Asynchronous version of ta_terminal_dcc_rates. Callback function is ta_cb_terminal_dcc_rates_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_deactivate | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Closes a user shift.
If the shift is already closed, no error is returned.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type deactivate_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_deactivate_async | ( | ta_object_t | terminal | ) |
Closes a user shift.
If the shift is already closed, no error is returned.
Asynchronous version of ta_terminal_deactivate. Callback function is ta_cb_terminal_deactivate_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_disconnect | ( | ta_object_t | terminal | ) |
Interrupts the connection to the EFT Terminal.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Disconnected from terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_disconnect_async | ( | ta_object_t | terminal | ) |
Interrupts the connection to the EFT Terminal.
Asynchronous version of ta_terminal_disconnect. Callback function is ta_cb_terminal_disconnected.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Started disconnecting from terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_dispose | ( | ta_object_t | terminal | ) |
Dispose of terminal.
Once disposed all terminal functionality returns ta_c_rc_invalid_argument if called.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Terminal has been disposed. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_eject_card | ( | ta_object_t | terminal | ) |
Eject a card from the card reader.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_eject_card_async | ( | ta_object_t | terminal | ) |
Eject a card from the card reader.
Asynchronous version of ta_terminal_eject_card. Callback function is ta_cb_terminal_eject_card_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_finish_checkout | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_finish_checkout_async | ( | ta_object_t | terminal | ) |
This function is used to finish a previously started checkout process with StartCheckout and to retrieve consumer loyalty data from the terminal that has been collected during this checkout process.
Asynchronous version of ta_terminal_finish_checkout. Callback function is ta_cb_terminal_finish_checkout_completed.
[in] | terminal | Object instance of type terminal. |
[out] | response | Variable to write object of type vas_checkout_information. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_get_act_seq_counter | ( | ta_object_t | terminal, |
int * | act_seq_counter | ||
) |
Activation sequence counter.
[in] | terminal | Object instance of type terminal. |
[out] | act_seq_counter | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to act_seq_counter. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | act_seq_counter is null-pointer. |
ta_e_result_code_t ta_terminal_get_brands | ( | ta_object_t | terminal, |
ta_object_t * | brands | ||
) |
Get brands or 0 if not retrieved yet.
[in] | terminal | Object instance of type terminal. |
[out] | brands | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not set in terminal. Otherwise object instance is of type list and object instance is retained. Elements in the list are of type brand. |
ta_c_rc_ok | Object instance written to brands. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | brands is null-pointer. |
ta_e_result_code_t ta_terminal_get_config_data | ( | ta_object_t | terminal, |
ta_object_t * | config_data | ||
) |
Get configuration data.
[in] | terminal | Object instance of type terminal. |
[out] | config_data | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not set in terminal. Otherwise object instance is of type config_data and object instance is retained. |
ta_c_rc_ok | Object instance written to config_data. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | config_data is null-pointer. |
ta_e_result_code_t ta_terminal_get_customer_data | ( | ta_object_t | terminal, |
ta_object_t * | customer_data | ||
) |
Customer data.
[in] | terminal | Object instance of type terminal. |
[out] | customer_data | Pointer to variable to write object instance to. Object instance is of type map. Object instance is retained. Elements in the map are of key type integer containing values of enumeration ta_e_customer_data_type_t and value type string. |
ta_c_rc_ok | Object instance written to customer_data. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | customer_data is null-pointer. |
ta_e_result_code_t ta_terminal_get_ecr_data | ( | ta_object_t | terminal, |
ta_object_t * | ecr_data | ||
) |
ECR Data.
[in] | terminal | Object instance of type terminal. |
[out] | ecr_data | Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type ecr_info. |
ta_c_rc_ok | Object instance written to ecr_data. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | ecr_data is null-pointer. |
ta_e_result_code_t ta_terminal_get_features | ( | ta_object_t | terminal, |
ta_s_features_t * | features, | ||
ta_e_boolean_t * | has_features | ||
) |
Get features if known.
[in] | terminal | Object instance of type terminal. |
[out] | features | Pointer to variable to write values to if features are known. Pointer can be null-pointer if only feature presence is of interest. |
[out] | has_features | Pointer to variable to write presence of features. Set to ta_c_b_true if features are present otherwise ta_c_b_false. |
ta_c_rc_ok | Feature presence written to has_features. If has_features is ta_c_b_true values are also written to features. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | has_features is null-pointer. |
ta_e_result_code_t ta_terminal_get_merchant_options | ( | ta_object_t | terminal, |
ta_object_t * | merchant_options | ||
) |
Merchant options.
[in] | terminal | Object instance of type terminal. |
[out] | merchant_options | Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type merchant_option. |
ta_c_rc_ok | Object instance written to merchant_options. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | merchant_options is null-pointer. |
ta_e_result_code_t ta_terminal_get_pos_id | ( | ta_object_t | terminal, |
ta_object_t * | pos_id | ||
) |
POS identifier.
[in] | terminal | Object instance of type terminal. |
[out] | pos_id | Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained. |
ta_c_rc_ok | Object instance written to pos_id. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | pos_id is null-pointer. |
ta_e_result_code_t ta_terminal_get_print_options | ( | ta_object_t | terminal, |
ta_object_t * | print_options | ||
) |
Print options.
[in] | terminal | Object instance of type terminal. |
[out] | print_options | Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type print_option. |
ta_c_rc_ok | Object instance written to print_options. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | print_options is null-pointer. |
ta_e_result_code_t ta_terminal_get_receipt_formatter | ( | ta_object_t | terminal, |
ta_object_t * | receipt_formatter | ||
) |
Receipt formatter.
[in] | terminal | Object instance of type terminal. |
[out] | formatter | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not set in terminal. If object instance is not ta_invalid_object it is of type receipt_formatter and will be retained. |
ta_c_rc_ok | Object instance written to formatter. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | formatter is null-pointer. |
ta_e_result_code_t ta_terminal_get_settings | ( | ta_object_t | terminal, |
ta_object_t * | settings | ||
) |
Immutable terminal settings.
[in] | terminal | Object instance of type terminal. |
[out] | settings | Pointer to variable to write object instance to. Object instance is of type terminal_settings. Object instance is retained. |
ta_c_rc_ok | Object instance written to settings. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | settings is null-pointer. |
ta_e_result_code_t ta_terminal_get_terminal_id | ( | ta_object_t | terminal, |
ta_object_t * | terminal_id | ||
) |
Terminal identifier of connected terminal.
Returns ta_object_invalid if the terminal identifier is not known. The terminal identifier is available after logging in to the terminal. The terminal identifier obtained from the terminal is potentially different from the terminal identifier set in the terminal_settings. This is especially true if ta_c_cm_on_fix_ip is used.
[in] | terminal | Object instance of type terminal. |
[out] | terminal_id | Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained. |
ta_c_rc_ok | Object instance written to settings. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | terminal_id is null-pointer. |
ta_e_result_code_t ta_terminal_get_terminal_status | ( | ta_object_t | terminal, |
ta_object_t * | terminal_status | ||
) |
Get terminal status.
[in] | terminal | Object instance of type terminal. |
[out] | terminal_status | Pointer to variable to write object instance to. Object instance is of type terminal_status. Object instance is retained. |
ta_c_rc_ok | Object instance written to terminal_status. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | terminal_status is null-pointer. |
ta_e_result_code_t ta_terminal_get_transaction_data | ( | ta_object_t | terminal, |
ta_object_t * | transaction_data | ||
) |
Transaction data to use for transaction requests unless set manually.
[in] | terminal | Object instance of type terminal. |
[out] | transaction_data | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not set in terminal. If object instance is not ta_invalid_object it is of type transaction_data and will be retained. |
ta_c_rc_ok | Object instance written to transaction_data. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | transaction_data is null-pointer. |
ta_e_result_code_t ta_terminal_get_user_id | ( | ta_object_t | terminal, |
int * | user_id | ||
) |
User identifier.
[in] | terminal | Object instance of type terminal. |
[out] | user_id | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to user_id. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | user_id is null-pointer. |
ta_e_result_code_t ta_terminal_hardware_information | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Get hardware information from the EFT Terminal.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type hardware_information_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_hardware_information_async | ( | ta_object_t | terminal | ) |
Get hardware information from the EFT Terminal.
Asynchronous version of ta_terminal_hardware_information. Callback function is ta_cb_terminal_hardware_information_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_has_sw_update | ( | ta_object_t | terminal, |
ta_e_boolean_t * | result | ||
) |
Software update is available.
[in] | terminal | Object instance of type terminal. |
[out] | result | Pointer to variable to write result to. |
ta_c_rc_ok | Result written to result. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | result is null-pointer. |
ta_e_result_code_t ta_terminal_hold_commit | ( | ta_object_t | terminal | ) |
Extends the Commit timeout if the terminal needs additional time before the Commit shall be performed.
An example could be on a public transport vending machine: if the machine is printing multiple tickets and this printing action would extend the commit timeout, a hold_commit notification shall be sent to extend the Commit timeout as well. If the printing action fails after some tickets a partial commit can be performed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Hold commit send to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_init_transaction | ( | ta_object_t | terminal, |
ta_e_boolean_t | display_amount, | ||
ta_object_t | amount, | ||
ta_object_t * | response | ||
) |
Initialize a transaction knowing the amount or the card type.
[in] | terminal | Object instance of type terminal. |
[in] | display_amount | ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal. |
[in] | amount | Object instance of type amount. Can be ta_invalid_object to not use an amount. display_amount has no effect if not amount is used. |
[out] | response | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not contained in the response. Otherwise object instance is of type card_data. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. If object instance is not ta_invalid_object object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and is not of type amount. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_init_transaction2 | ( | ta_object_t | terminal, |
ta_e_boolean_t | display_amount, | ||
ta_object_t | amount, | ||
ta_e_function_hint_t | function_hint, | ||
ta_object_t * | response | ||
) |
Initialize a transaction knowing the amount or the card type.
[in] | terminal | Object instance of type terminal. |
[in] | display_amount | ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal. |
[in] | amount | Object instance of type amount. Can be ta_invalid_object to not use an amount. display_amount has no effect if not amount is used. |
[in] | function_hint | Function hint. |
[out] | response | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not contained in the response. Otherwise object instance is of type card_data. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. If object instance is not ta_invalid_object object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and is not of type amount. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_init_transaction2_async | ( | ta_object_t | terminal, |
ta_e_boolean_t | display_amount, | ||
ta_object_t | amount, | ||
ta_e_function_hint_t | function_hint | ||
) |
Initialize a transaction knowing the amount or the card type.
Asynchronous version of ta_terminal_init_transaction. Callback function is ta_cb_terminal_init_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | display_amount | ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal. |
[in] | amount | Object instance of type amount. Can be ta_invalid_object to not use an amount. display_amount has no effect if not amount is used. |
[in] | function_hint | Function hint. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_terminal_init_transaction_async | ( | ta_object_t | terminal, |
ta_e_boolean_t | display_amount, | ||
ta_object_t | amount | ||
) |
Initialize a transaction knowing the amount or the card type.
Asynchronous version of ta_terminal_init_transaction. Callback function is ta_cb_terminal_init_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | display_amount | ta_c_b_true to display amount on screen. ta_c_b_false to not display amount on screen. ta_c_b_undefined to use default behavior of terminal. |
[in] | amount | Object instance of type amount. Can be ta_invalid_object to not use an amount. display_amount has no effect if not amount is used. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is not ta_invalid_object and is not of type amount. |
ta_e_result_code_t ta_terminal_login | ( | ta_object_t | terminal | ) |
Activate a communication session between the ECR and the terminal.
After completing the request updates the features, brands and terminal identifier in the terminal instance. Fetching these information can be disabled if Auto-FetchBrands is disabled terminal_settings
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_login_async | ( | ta_object_t | terminal | ) |
Activate a communication session between the ECR and the terminal.
Asynchronous version of ta_terminal_login. Callback function is ta_cb_terminal_login_completed.
After completing the request updates the features, brands and terminal identifier in the terminal instance. Fetching these information can be disabled if Auto-FetchBrands is disabled terminal_settings
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_logout | ( | ta_object_t | terminal | ) |
Terminates an active communication session between the ECR and the terminal.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_logout_async | ( | ta_object_t | terminal | ) |
Terminates an active communication session between the ECR and the terminal.
Asynchronous version of ta_terminal_logout. Callback function is ta_cb_terminal_logout_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_loyalty_data | ( | ta_object_t | terminal, |
ta_e_loyalty_function_type_t | function_type, | ||
ta_object_t | data_type, | ||
ta_object_t | data, | ||
ta_e_boolean_t | retain_card, | ||
ta_object_t * | response | ||
) |
This function is used to query and configure loyalty information.
[in] | terminal | Object instance of type terminal. |
[in] | function_type | Defines what kind of loyalty mode will be used. |
[in] | data_type | Specifies type of loyalty data. Mandatory for function_type ta_c_lft_init, ta_c_lft_update and ta_c_lft_deinit. If not ta_invalid_object has to be of type string. |
[in] | data | Loyalty data. Object of type string. |
[in] | retain_card | ta_c_b_true to not eject card otherwise ta_c_b_false. |
[out] | response | Variable to write object of type card_data. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | function_type is not a valid value of ta_e_loyalty_function_type_t. |
ta_c_rc_invalid_argument | data_type is not ta_invalid_object and is not of type string. |
ta_c_rc_invalid_argument | data is ta_invalid_object. |
ta_c_rc_invalid_argument | data is not of type string. |
ta_c_rc_invalid_argument | retain_card is ta_c_b_undefined. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_loyalty_data_async | ( | ta_object_t | terminal, |
ta_e_loyalty_function_type_t | function_type, | ||
ta_object_t | data_type, | ||
ta_object_t | data, | ||
ta_e_boolean_t | retain_card | ||
) |
This function is used to query and configure loyalty information.
Asynchronous version of ta_terminal_loyalty_data. Callback function is ta_cb_terminal_loyalty_data_completed.
[in] | terminal | Object instance of type terminal. |
[in] | function_type | Defines what kind of loyalty mode will be used. |
[in] | data_type | Specifies type of loyalty data. Mandatory for function_type ta_c_lft_init, ta_c_lft_update and ta_c_lft_deinit. If not ta_invalid_object has to be of type string. |
[in] | data | Loyalty data. Object of type string. |
[in] | retain_card | ta_c_b_true to not eject card otherwise ta_c_b_false. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | function_type is not a valid value of ta_e_loyalty_function_type_t. |
ta_c_rc_invalid_argument | data_type is not ta_invalid_object and is not of type string. |
ta_c_rc_invalid_argument | data is ta_invalid_object. |
ta_c_rc_invalid_argument | data is not of type string. |
ta_c_rc_invalid_argument | retain_card is ta_c_b_undefined. |
ta_e_result_code_t ta_terminal_open_dialog_mode | ( | ta_object_t | terminal | ) |
Open dialog mode on the terminal.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_open_dialog_mode_async | ( | ta_object_t | terminal | ) |
Open dialog mode on the terminal.
Asynchronous version of ta_terminal_open_dialog_mode. Callback function is ta_cb_terminal_open_dialog_mode_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_open_maintenance_window | ( | ta_object_t | terminal | ) |
Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.
The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_open_maintenance_window_async | ( | ta_object_t | terminal | ) |
Opens the maintenance window to the terminal so it can perform collected maintenance requests on its own, without interaction with the ECR.
The terminal shall respond immediately to the ECR request whether it is able to handle the request or not.
If the terminal is able to handle the request, the ECR is free itself to perform maintenance as well or it can monitor the terminal by reading the terminal_status notifications.
It is possible that the connection between ECR and EFT terminal is terminated due to one or multiple reboot processes.
Asynchronous version of ta_terminal_open_maintenance_window. Callback function is ta_cb_terminal_open_maintenance_window_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_open_reader | ( | ta_object_t | terminal | ) |
Open the shutter of the card reader.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_open_reader_async | ( | ta_object_t | terminal | ) |
Open the shutter of the card reader.
Asynchronous version of ta_terminal_open_reader. Callback function is ta_cb_terminal_open_reader_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_print_on_terminal | ( | ta_object_t | terminal, |
ta_object_t | ticket_data | ||
) |
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal.
The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].
[in] | terminal | Object instance of type terminal. |
[in] | ticket_data | Object instance of type string. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | ticket_data is ta_invalid_object. |
ta_c_rc_invalid_argument | ticket_data is not of type string. |
ta_e_result_code_t ta_terminal_print_on_terminal_async | ( | ta_object_t | terminal, |
ta_object_t | ticket_data | ||
) |
The PrintOnTerminal-function is used to send a freetext preformatted ticket from ECR to terminal.
The ticket is then printed on the terminal printer. The ticket must be formatted according [B39].
Asynchronous version of ta_terminal_print_on_terminal. Callback function is ta_cb_terminal_print_on_terminal_completed.
[in] | terminal | Object instance of type terminal. |
[in] | ticket_data | Object instance of type string. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | ticket_data is ta_invalid_object. |
ta_c_rc_invalid_argument | ticket_data is not of type string. |
ta_e_result_code_t ta_terminal_provide_loyalty_basket | ( | ta_object_t | terminal, |
ta_object_t | basket, | ||
ta_object_t * | response | ||
) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.
[in] | terminal | Object instance of type terminal. |
[in] | basket | Object of type list to send. Object contains elements of type loyalty_item. |
[out] | response | Variable to write object of type list. Object contains elements of type loyalty_item. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | basket is ta_invalid_object. |
ta_c_rc_invalid_argument | basket is not of type list. |
ta_c_rc_invalid_argument | Element in basket is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in basket is not of type loyalty_item. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_provide_loyalty_basket_async | ( | ta_object_t | terminal, |
ta_object_t | basket | ||
) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.
Asynchronous version of ta_terminal_provide_loyalty_basket. Callback function is ta_cb_terminal_provide_loyalty_basket_completed.
[in] | terminal | Object instance of type terminal. |
[in] | basket | Object of type list to send. Object contains elements of type loyalty_item. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_provide_vas_result | ( | ta_object_t | terminal, |
ta_object_t | result, | ||
ta_object_t * | response | ||
) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.
[in] | terminal | Object instance of type terminal. |
[in] | result | Object of type vas_result to send. |
[out] | response | Variable to write object of type vas_result. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | result is ta_invalid_object. |
ta_c_rc_invalid_argument | result is not of type vas_result. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_provide_vas_result_async | ( | ta_object_t | terminal, |
ta_object_t | result | ||
) |
This function is used to provide the terminal with a LoyaltyBasket if the corresponding loyalty scheme requires it.
Asynchronous version of ta_terminal_provide_vas_result. Callback function is ta_cb_terminal_provide_vas_result_completed.
[in] | terminal | Object instance of type terminal. |
[in] | result | Object of type vas_result to send. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_reboot | ( | ta_object_t | terminal | ) |
Force the EFT Terminal to reboot.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_reboot_async | ( | ta_object_t | terminal | ) |
Force the EFT Terminal to reboot.
Asynchronous version of ta_terminal_reboot. Callback function is ta_cb_terminal_reboot_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_receipt_request | ( | ta_object_t | terminal, |
ta_e_receipt_request_type_t | type, | ||
ta_object_t * | response | ||
) |
Receive the latest receipt or a list of silent receipts.
[in] | terminal | Object instance of type terminal. |
[in] | type | Type of receipts to receive. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type receipt_request_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_receipt_request_async | ( | ta_object_t | terminal, |
ta_e_receipt_request_type_t | type | ||
) |
Receive the latest receipt or a list of silent receipts.
Asynchronous version of ta_terminal_receipt_request. Callback function is ta_cb_terminal_receipt_request_completed.
[in] | terminal | Object instance of type terminal. |
[in] | type | Type of receipts to receive. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_reconciliation | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Force the EFT Terminal to transmit all financial transactions to the host system.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type reconciliation_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_reconciliation2 | ( | ta_object_t | terminal, |
ta_e_reconciliation_mode_t | reconciliation_mode, | ||
ta_object_t * | response | ||
) |
Force the EFT Terminal to transmit all financial transactions to the host system.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type reconciliation_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_reconciliation2_async | ( | ta_object_t | terminal, |
ta_e_reconciliation_mode_t | reconciliation_mode | ||
) |
Force the EFT Terminal to transmit all financial transactions to the host system.
Asynchronous version of ta_terminal_reconciliation. Callback function is ta_cb_terminal_reconciliation_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_reconciliation_async | ( | ta_object_t | terminal | ) |
Force the EFT Terminal to transmit all financial transactions to the host system.
Asynchronous version of ta_terminal_reconciliation. Callback function is ta_cb_terminal_reconciliation_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_reconfig | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Force the EFT Terminal to get the configuration from the service center.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not contained in response. Otherwise object instance is of type print_data. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. If object instance is not ta_invalid_object object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_reconfig_async | ( | ta_object_t | terminal | ) |
Force the EFT Terminal to get the configuration from the service center.
Asynchronous version of ta_terminal_reconfig. Callback function is ta_cb_terminal_reconfig_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_remove_listener | ( | ta_object_t | terminal, |
ta_object_t | listener | ||
) |
Unregister listener.
[in] | terminal | Object instance of type terminal. |
[in] | listener | Object instance of type terminal_listener. |
ta_c_rc_ok | Listener removed from terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | listener is ta_invalid_object. |
ta_e_result_code_t ta_terminal_request_alias | ( | ta_object_t | terminal, |
ta_object_t | six_trans_ref, | ||
ta_object_t * | response | ||
) |
The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions.
Saferpay offers these kind of transactions which can be performed only using a secure Alias that can be created out of card information from a precious transaction. This Alias then can be used to perform a transaction without having the same card present.
An Alias can be used for the following transactions:
[in] | terminal | Object instance of type terminal. |
[in] | six_trans_ref | Object instance of type string. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type string. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | six_trans_ref is ta_invalid_object. |
ta_c_rc_invalid_argument | six_trans_ref is not of type string. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_request_alias_async | ( | ta_object_t | terminal, |
ta_object_t | six_trans_ref | ||
) |
The RequestAlias-function is used to request a Saferpay Alias for Alias-based transactions.
Saferpay offers these kind of transactions which can be performed only using a secure Alias that can be created out of card information from a precious transaction. This Alias then can be used to perform a transaction without having the same card present.
An Alias can be used for the following transactions:
Asynchronous version of ta_terminal_request_alias. Callback function is ta_cb_terminal_request_alias_completed.
[in] | terminal | Object instance of type terminal. |
[in] | six_trans_ref | Object instance of type string. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | six_trans_ref is ta_invalid_object. |
ta_c_rc_invalid_argument | six_trans_ref is not of type string. |
ta_e_result_code_t ta_terminal_rollback | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization.
For payment protocols supporting the function a declined receipt may be generated.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is ta_invalid_object if not contained in response. Otherwise object instance is of type print_data. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_rollback_async | ( | ta_object_t | terminal | ) |
Prevents a transaction from being committed to the transaction log and generates a technical reversal of the authorization.
For payment protocols supporting the function a declined receipt may be generated.
Asynchronous version of ta_terminal_rollback. Callback function is ta_cb_terminal_rollback_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_send_card_command | ( | ta_object_t | terminal, |
ta_object_t | requests, | ||
ta_object_t * | responses | ||
) |
Send card command.
This function is used for a direct communication with the inserted card using APDUs. It is possible to send a list of APDU command in the request (sixml:CommandRequestList) and to set responses that shall be accepted as "Positive" responses using sixml:PositiveAnswerList
Each sixml:CommandRequest is numbered with a unique order number (starting with 1). In the response, the terminal sends the response of the device for each CommandRequest, including the order number of the request.
If the device answers with a negative response (i.e. SW1SW2 != 9000 or other as "positive" defined answers using sixml:PositiveAnswerList), the processing of the sixml:CommandRequests is aborted, and the remaining commands are not sent to the device.
Furthermore it can be defined which dialogs shall be shown using the container sixml:CommandResources in the following use cases:
[in] | terminal | Object instance of type terminal. |
[in] | requests | Object instance of type list. Elements in the list have to be of type command_request. |
[out] | responses | Pointer to variable to write object instance to. Object instance is of type list. Object instance is retained. Elements in the list are of type command_response. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | requests is ta_invalid_object. |
ta_c_rc_invalid_argument | requests is not of type list. |
ta_c_rc_invalid_argument | Element in requests is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in requests is not of type command_request. |
ta_c_rc_invalid_argument | responses is null-pointer. |
ta_e_result_code_t ta_terminal_send_card_command_async | ( | ta_object_t | terminal, |
ta_object_t | requests | ||
) |
Send card command.
Asynchronous version of ta_terminal_send_card_command. Callback function is ta_cb_terminal_send_card_command_completed.
[in] | terminal | Object instance of type terminal. |
[in] | requests | Object instance of type list. Elements in the list have to be of type command_request. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | Element in requests is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in requests is not of type command_request. |
ta_e_result_code_t ta_terminal_set_custom_logger | ( | ta_object_t | terminal, |
ta_cb_publish_log_record | callback, | ||
void * | user_pointer | ||
) |
Set custom terminal logger callback.
If not null-pointer the callback is used whenever the terminal logger needs to publish a new log record. The terminal logger is used whenever a terminal function is called, hence any function of ta_terminal_*. In all other cases the global logger is used. You can use the same logger for both global and terminal specific logging. If no custom terminal logger is set the global one is used if set.
[in] | terminal | Object instance of type terminal. |
[in] | callback | Callback to set. Can be null-pointer to disable. |
[in] | user_pointer | User pointer to use in the callback. |
ta_c_rc_ok | Listener removed from terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_e_result_code_t ta_terminal_set_customer_data | ( | ta_object_t | terminal, |
ta_object_t | customer_data | ||
) |
Set Customer data.
[in] | terminal | Object instance of type terminal. |
[in] | customer_data | Object instance to set. Object instance has to be of type map. Elements in the list have to be of key type integer with values from enumeration ta_e_customer_data_type_t and value type string. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | customer_data is ta_invalid_object. |
ta_c_rc_invalid_argument | customer_data is not of type map. |
ta_c_rc_invalid_argument | Element value in customer_data is ta_invalid_object. |
ta_c_rc_invalid_argument | Element key in customer_data is not of type integer.h "integer" with values from enumeration ta_e_customer_data_type_t. |
ta_c_rc_invalid_argument | Element value in customer_data is not of type string.h "string". |
ta_e_result_code_t ta_terminal_set_ecr_data | ( | ta_object_t | terminal, |
ta_object_t | ecr_data | ||
) |
Set ECR Data.
[in] | terminal | Object instance of type terminal. |
[in] | ecr_data | Object instance to set. Object instance has to be of type list. Elements in the list have to be of type ecr_info. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | ecr_data is ta_invalid_object. |
ta_c_rc_invalid_argument | ecr_data is not of type list. |
ta_c_rc_invalid_argument | Element in ecr_data is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in ecr_data is not of type ecr_info. |
ta_e_result_code_t ta_terminal_set_merchant_options | ( | ta_object_t | terminal, |
ta_object_t | merchant_options | ||
) |
Set Merchant options.
[in] | terminal | Object instance of type terminal. |
[in] | merchant_options | Object instance to set. Object instance has to be of type list. Elements in the list have to be of type merchant_option. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | merchant_options is ta_invalid_object. |
ta_c_rc_invalid_argument | merchant_options is not of type list. |
ta_c_rc_invalid_argument | Element in merchant_options is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in merchant_options is not of type merchant_option. |
ta_e_result_code_t ta_terminal_set_pos_id | ( | ta_object_t | terminal, |
ta_object_t | pos_id | ||
) |
Set POS identifier.
[in] | terminal | Object instance of type terminal. |
[in] | pos_id | Object instance to set. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | pos_id is ta_invalid_object. |
ta_c_rc_invalid_argument | pos_id is not of type string. |
ta_e_result_code_t ta_terminal_set_print_options | ( | ta_object_t | terminal, |
ta_object_t | print_options | ||
) |
Set Print options.
[in] | terminal | Object instance of type terminal. |
[in] | print_options | Object instance to set. Object instance has to be of type list. Elements in the list have to be of type print_option. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | print_options is ta_invalid_object. |
ta_c_rc_invalid_argument | print_options is not of type list. |
ta_c_rc_invalid_argument | Element in print_options is ta_invalid_object. |
ta_c_rc_invalid_argument | Element in print_options is not of type print_option. |
ta_e_result_code_t ta_terminal_set_receipt_formatter | ( | ta_object_t | terminal, |
ta_object_t | formatter | ||
) |
Set receipt formatter.
[in] | terminal | Object instance of type terminal. |
[in] | formatter | Object instance to set. Object instance can be ta_invalid_object to clear the value in terminal. If object instance is not ta_invalid_object it has to be of type receipt_formatter. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | formatter is not ta_invalid_object and is not of type receipt_formatter. |
ta_e_result_code_t ta_terminal_set_transaction_data | ( | ta_object_t | terminal, |
ta_object_t | transaction_data | ||
) |
Set transaction data to use for transaction requests unless set manually.
[in] | terminal | Object instance of type terminal. |
[in] | transaction_data | Object instance to set. Object instance can be ta_invalid_object to clear the value in terminal. If object instance is not ta_invalid_object it has to be of type transaction_data. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | transaction_data is not ta_invalid_object and is not of type transaction_data. |
ta_e_result_code_t ta_terminal_set_user_id | ( | ta_object_t | terminal, |
int | user_id | ||
) |
Set User identifier.
[in] | terminal | Object instance of type terminal. |
[in] | user_id | Value to set. |
ta_c_rc_ok | Object instance assigned to terminal. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | user_id is less than 0. |
ta_e_result_code_t ta_terminal_show_dialog | ( | ta_object_t | terminal, |
ta_object_t | request, | ||
ta_object_t * | response | ||
) |
Show dialog on the terminal.
Can be called only if dialog mode is open.
[in] | terminal | Object instance of type terminal. |
[in] | request | Object instance of type show_dialog_request. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type show_dialog_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_show_dialog_async | ( | ta_object_t | terminal, |
ta_object_t | request | ||
) |
Show dialog on the terminal.
Asynchronous version of ta_terminal_show_dialog. Callback function is ta_cb_terminal_show_dialog_completed.
[in] | terminal | Object instance of type terminal. |
[in] | request | Object instance of type show_dialog_request. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_dialog_request. |
ta_e_result_code_t ta_terminal_show_signature_capture | ( | ta_object_t | terminal, |
ta_object_t | request, | ||
ta_object_t * | response | ||
) |
Show signature capture on the terminal.
Can be called only if dialog mode is open.
[in] | terminal | Object instance of type terminal. |
[in] | request | Object instance of type show_signature_capture_request. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type show_signature_capture_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_signature_capture_request. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_show_signature_capture_async | ( | ta_object_t | terminal, |
ta_object_t | request | ||
) |
Request system information from the EFT Terminal.
Asynchronous version of ta_terminal_show_signature_capture. Callback function is ta_cb_terminal_show_signature_capture_completed.
[in] | terminal | Object instance of type terminal. |
[in] | request | Object instance of type show_signature_capture_request. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type show_signature_capture_request. |
ta_e_result_code_t ta_terminal_software_update | ( | ta_object_t | terminal, |
ta_e_update_status_t * | response | ||
) |
Force the EFT Terminal to start a Software Update.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write value to. |
ta_c_rc_ok | Request finished successfully. Value written to response. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_software_update_async | ( | ta_object_t | terminal | ) |
Force the EFT Terminal to start a Software Update.
Asynchronous version of ta_terminal_software_update. Callback function is ta_cb_terminal_software_update_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_start_checkout | ( | ta_object_t | terminal | ) |
This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started.
Therefore the SIX QR code is displayed at the terminal. The timeout how long the QR code shall be displayed on the terminal before returning to its Idle screen can be defined in the Login request using the OptionType - QRCTimeout, see SIXml Book C: Appendix for further information.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request finished successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_start_checkout_async | ( | ta_object_t | terminal | ) |
This function is used to start a Checkout process at the POS to collect card and/or cardholder loyalty information before a transaction is started.
Therefore the SIX QR code is displayed at the terminal. The timeout how long the QR code shall be displayed on the terminal before returning to its Idle screen can be defined in the Login request using the OptionType - QRCTimeout, see SIXml Book C: Appendix for further information.
Asynchronous version of ta_terminal_start_checkout. Callback function is ta_cb_terminal_start_checkout_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_system_information | ( | ta_object_t | terminal, |
ta_object_t * | response | ||
) |
Request system information from the EFT Terminal.
[in] | terminal | Object instance of type terminal. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type system_information_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_system_information_async | ( | ta_object_t | terminal | ) |
Request system information from the EFT Terminal.
Asynchronous version of ta_terminal_system_information. Callback function is ta_cb_terminal_system_information_completed.
[in] | terminal | Object instance of type terminal. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_e_result_code_t ta_terminal_transaction | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount, | ||
ta_object_t * | response | ||
) |
Starts an EFT Terminal Transaction.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_transaction2 | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | request, | ||
ta_object_t * | response | ||
) |
Starts an EFT Terminal Transaction.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | request | Object instance of type transaction_request. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type transaction_request. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_transaction2_async | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | request | ||
) |
Starts an EFT Terminal Transaction.
Asynchronous version of ta_terminal_transaction2. Callback function is ta_cb_terminal_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | request | Object instance of type transaction_request. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | request is ta_invalid_object. |
ta_c_rc_invalid_argument | request is not of type transaction_request. |
ta_e_result_code_t ta_terminal_transaction_async | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount | ||
) |
Starts an EFT Terminal Transaction.
Asynchronous version of ta_terminal_transaction. Callback function is ta_cb_terminal_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_e_result_code_t ta_terminal_transaction_cashback | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount, | ||
ta_object_t | amount_cashback, | ||
ta_object_t * | response | ||
) |
Starts an EFT Terminal Transaction.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
[in] | amount_cashback | Object instance of type amount. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount_cashback is ta_invalid_object. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_transaction_cashback_async | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount, | ||
ta_object_t | amount_cashback | ||
) |
Starts an EFT Terminal Transaction.
Asynchronous version of ta_terminal_transaction_cashback. Callback function is ta_cb_terminal_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
[in] | amount_cashback | Object instance of type amount. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount_cashback is ta_invalid_object. |
ta_e_result_code_t ta_terminal_transaction_tip | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount, | ||
ta_object_t | amount_tip, | ||
ta_object_t * | response | ||
) |
Starts an EFT Terminal Transaction.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
[in] | amount_tip | Object instance of type amount. |
[out] | response | Pointer to variable to write object instance to. Object instance is of type transaction_response. Object instance is retained. |
ta_c_rc_ok | Request finished successfully. Object instance written to response. Object instance has been retained. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount_tip is ta_invalid_object. |
ta_c_rc_invalid_argument | response is null-pointer. |
ta_e_result_code_t ta_terminal_transaction_tip_async | ( | ta_object_t | terminal, |
ta_e_transaction_type_t | type, | ||
ta_object_t | amount, | ||
ta_object_t | amount_tip | ||
) |
Starts an EFT Terminal Transaction.
Asynchronous version of ta_terminal_transaction_tip. Callback function is ta_cb_terminal_transaction_completed.
[in] | terminal | Object instance of type terminal. |
[in] | type | Transaction type. |
[in] | amount | Object instance of type amount. |
[in] | amount_tip | Object instance of type amount. |
ta_c_rc_ok | Request started successfully. |
ta_c_rc_invalid_argument | terminal is ta_invalid_object. |
ta_c_rc_invalid_argument | terminal is not of type terminal. |
ta_c_rc_invalid_argument | terminal has been disposed. |
ta_c_rc_invalid_argument | amount is ta_invalid_object. |
ta_c_rc_invalid_argument | amount_tip is ta_invalid_object. |