TIM SDK
TIM API C
transaction_response.h File Reference

Description

Transaction response.

Object type transaction_response.

Typedefs

typedef enum ta_e_transaction_response_action ta_e_transaction_response_action_t
 Action.
 

Enumerations

enum  ta_e_transaction_response_action { ta_c_tra_none, ta_c_tra_cardholder_signature, ta_c_tra_merchant_signature }
 Action. More...
 

Functions

ta_e_result_code_t ta_transaction_response_get_type (ta_object_t response, ta_e_transaction_type_t *type)
 Transaction type. More...
 
ta_e_result_code_t ta_transaction_response_get_amount (ta_object_t response, ta_object_t *amount)
 Amount. More...
 
ta_e_result_code_t ta_transaction_response_get_amount_due (ta_object_t response, ta_object_t *amount_due)
 Due amount in the transaction. More...
 
ta_e_result_code_t ta_transaction_response_get_amount_tip (ta_object_t response, ta_object_t *amount_tip)
 Tip amount in the transaction. More...
 
ta_e_result_code_t ta_transaction_response_get_amount_dcc (ta_object_t response, ta_object_t *amount_dcc)
 DCC amount authorized by the transaction if present. More...
 
ta_e_result_code_t ta_transaction_response_get_amount_saldo (ta_object_t response, ta_object_t *amount_saldo)
 Saldo amount if present. More...
 
ta_e_result_code_t ta_transaction_response_get_transaction_information (ta_object_t response, ta_object_t *transaction_information)
 Information about completed transaction. More...
 
ta_e_result_code_t ta_transaction_response_get_dcc_disclaimer (ta_object_t response, ta_object_t *dcc_disclaimer)
 Disclaimer sent by host. More...
 
ta_e_result_code_t ta_transaction_response_get_card_data (ta_object_t response, ta_object_t *card_data)
 Information about payment card used by the cardholder if present. More...
 
ta_e_result_code_t ta_transaction_response_get_print_data (ta_object_t response, ta_object_t *print_data)
 Print information for merchant and cardholder receipts. More...
 
ta_e_result_code_t ta_transaction_response_get_additional_info (ta_object_t response, ta_object_t *additional_info)
 Additional information list. More...
 
ta_e_result_code_t ta_transaction_response_get_basket (ta_object_t response, ta_object_t *basket)
 Petrol: Basket. More...
 
ta_e_result_code_t ta_transaction_response_was_dcc (ta_object_t response, ta_e_boolean_t *was_dcc)
 Transaction has been using DCC. More...
 
ta_e_result_code_t ta_transaction_response_was_tip (ta_object_t response, ta_e_boolean_t *was_tip)
 Transaction has been using TIP. More...
 
ta_e_result_code_t ta_transaction_response_needs_action (ta_object_t response, ta_e_transaction_response_action_t *needs_action)
 Transaction requires an action. More...
 
ta_e_result_code_t ta_transaction_response_was_partial_approved (ta_object_t response, ta_e_boolean_t *was_partial_approved)
 Transaction has been partially approved. More...
 
ta_e_result_code_t ta_transaction_response_card_country_type (ta_object_t response, ta_object_t *country_code)
 Card country code if present. More...
 
ta_e_result_code_t ta_transaction_response_terminal_country_type (ta_object_t response, ta_object_t *country_code)
 Terminal country code if present. More...
 
ta_e_result_code_t ta_transaction_response_is_domestic (ta_object_t response, ta_e_boolean_t *is_domestic)
 Determines if transaction has been domestic. More...
 

Enumeration Type Documentation

◆ ta_e_transaction_response_action

Action.

Enumerator
ta_c_tra_none 

No action.

ta_c_tra_cardholder_signature 

Cardholder signature action.

ta_c_tra_merchant_signature 

Merchant signature action.

Function Documentation

◆ ta_transaction_response_card_country_type()

ta_e_result_code_t ta_transaction_response_card_country_type ( ta_object_t  response,
ta_object_t country_code 
)

Card country code if present.

Parameters
[in]responseObject instance of type transaction_response.
[out]country_codePointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to country_code.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentcountry_code is null-pointer.

◆ ta_transaction_response_get_additional_info()

ta_e_result_code_t ta_transaction_response_get_additional_info ( ta_object_t  response,
ta_object_t additional_info 
)

Additional information list.

Parameters
[in]responseObject instance of type transaction_response.
[out]additional_infoPointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys of type integer and values of type string.
Return values
ta_c_rc_okObject instance written to additional_info.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentadditional_info is null-pointer.

◆ ta_transaction_response_get_amount()

ta_e_result_code_t ta_transaction_response_get_amount ( ta_object_t  response,
ta_object_t amount 
)

Amount.

Parameters
[in]responseObject instance of type transaction_response.
[out]amountPointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to amount.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentamount is null-pointer.

◆ ta_transaction_response_get_amount_dcc()

ta_e_result_code_t ta_transaction_response_get_amount_dcc ( ta_object_t  response,
ta_object_t amount_dcc 
)

DCC amount authorized by the transaction if present.

Parameters
[in]responseObject instance of type transaction_response.
[out]amount_dccPointer to variable to write object instance to. Object instance is of type amount_dcc and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to amount_dcc.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentamount_dcc is null-pointer.

◆ ta_transaction_response_get_amount_due()

ta_e_result_code_t ta_transaction_response_get_amount_due ( ta_object_t  response,
ta_object_t amount_due 
)

Due amount in the transaction.

Parameters
[in]responseObject instance of type transaction_response.
[out]amount_duePointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to amount_due.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentamount_due is null-pointer.

◆ ta_transaction_response_get_amount_saldo()

ta_e_result_code_t ta_transaction_response_get_amount_saldo ( ta_object_t  response,
ta_object_t amount_saldo 
)

Saldo amount if present.

Parameters
[in]responseObject instance of type transaction_response.
[out]amount_saldoPointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to amount_saldo.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentamount_saldo is null-pointer.

◆ ta_transaction_response_get_amount_tip()

ta_e_result_code_t ta_transaction_response_get_amount_tip ( ta_object_t  response,
ta_object_t amount_tip 
)

Tip amount in the transaction.

Parameters
[in]responseObject instance of type transaction_response.
[out]amount_duePointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to amount_due.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentamount_due is null-pointer.

◆ ta_transaction_response_get_basket()

ta_e_result_code_t ta_transaction_response_get_basket ( ta_object_t  response,
ta_object_t basket 
)

Petrol: Basket.

Parameters
[in]responseObject instance of type transaction_response.
[out]basketPointer to variable to write object instance to. Object instance is of type basket and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to basket.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentbasket is null-pointer.

◆ ta_transaction_response_get_card_data()

ta_e_result_code_t ta_transaction_response_get_card_data ( ta_object_t  response,
ta_object_t card_data 
)

Information about payment card used by the cardholder if present.

Parameters
[in]responseObject instance of type transaction_response.
[out]card_dataPointer to variable to write object instance to. Object instance is of type card_data and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to card_data.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentcard_data is null-pointer.

◆ ta_transaction_response_get_dcc_disclaimer()

ta_e_result_code_t ta_transaction_response_get_dcc_disclaimer ( ta_object_t  response,
ta_object_t dcc_disclaimer 
)

Disclaimer sent by host.

Parameters
[in]responseObject instance of type transaction_response.
[out]dcc_disclaimerPointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to dcc_disclaimer.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentdcc_disclaimer is null-pointer.

◆ ta_transaction_response_get_print_data()

ta_e_result_code_t ta_transaction_response_get_print_data ( ta_object_t  response,
ta_object_t print_data 
)

Print information for merchant and cardholder receipts.

Parameters
[in]responseObject instance of type transaction_response.
[out]print_dataPointer to variable to write object instance to. Object instance is of type print_data and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to print_data.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentprint_data is null-pointer.

◆ ta_transaction_response_get_transaction_information()

ta_e_result_code_t ta_transaction_response_get_transaction_information ( ta_object_t  response,
ta_object_t transaction_information 
)

Information about completed transaction.

Parameters
[in]responseObject instance of type transaction_response.
[out]transaction_informationPointer to variable to write object instance to. Object instance is of type transaction_information and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to transaction_information.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumenttransaction_information is null-pointer.

◆ ta_transaction_response_get_type()

ta_e_result_code_t ta_transaction_response_get_type ( ta_object_t  response,
ta_e_transaction_type_t type 
)

Transaction type.

Parameters
[in]responseObject instance of type transaction_response.
[out]typePointer to variable to write value to.
Return values
ta_c_rc_okValue written to type.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumenttype is null-pointer.

◆ ta_transaction_response_is_domestic()

ta_e_result_code_t ta_transaction_response_is_domestic ( ta_object_t  response,
ta_e_boolean_t is_domestic 
)

Determines if transaction has been domestic.

Parameters
[in]responseObject instance of type transaction_response.
[out]is_domesticPointer to variable to write value to. Set to ta_c_b_true if card country code and terminal country code are both set in response and are have equal value.
Return values
ta_c_rc_okValue written to is_domestic.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentis_domestic is null-pointer.

◆ ta_transaction_response_needs_action()

ta_e_result_code_t ta_transaction_response_needs_action ( ta_object_t  response,
ta_e_transaction_response_action_t needs_action 
)

Transaction requires an action.

Parameters
[in]responseObject instance of type transaction_response.
[out]needs_actionPointer to variable to write value to.
Return values
ta_c_rc_okValue written to needs_action.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentneeds_action is null-pointer.

◆ ta_transaction_response_terminal_country_type()

ta_e_result_code_t ta_transaction_response_terminal_country_type ( ta_object_t  response,
ta_object_t country_code 
)

Terminal country code if present.

Parameters
[in]responseObject instance of type transaction_response.
[out]country_codePointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_invalid_object if value is not set in response.
Return values
ta_c_rc_okObject instance written to country_code.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentcountry_code is null-pointer.

◆ ta_transaction_response_was_dcc()

ta_e_result_code_t ta_transaction_response_was_dcc ( ta_object_t  response,
ta_e_boolean_t was_dcc 
)

Transaction has been using DCC.

Parameters
[in]responseObject instance of type transaction_response.
[out]was_dccPointer to variable to write value to. Set to ta_c_b_true if transaction has been using DCC.
Return values
ta_c_rc_okValue written to was_dcc.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentwas_dcc is null-pointer.

◆ ta_transaction_response_was_partial_approved()

ta_e_result_code_t ta_transaction_response_was_partial_approved ( ta_object_t  response,
ta_e_boolean_t was_partial_approved 
)

Transaction has been partially approved.

Parameters
[in]responseObject instance of type transaction_response.
[out]was_partial_approvedPointer to variable to write value to. Set to ta_c_b_true if transaction has been partially approved.
Return values
ta_c_rc_okValue written to was_partial_approved.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentwas_partial_approved is null-pointer.

◆ ta_transaction_response_was_tip()

ta_e_result_code_t ta_transaction_response_was_tip ( ta_object_t  response,
ta_e_boolean_t was_tip 
)

Transaction has been using TIP.

Parameters
[in]responseObject instance of type transaction_response.
[out]was_tipPointer to variable to write value to. Set to ta_c_b_true if transaction has been using TIP.
Return values
ta_c_rc_okValue written to was_tip.
ta_c_rc_invalid_argumentresponse is ta_invalid_object.
ta_c_rc_invalid_argumentresponse is not of type transaction_response.
ta_c_rc_invalid_argumentwas_tip is null-pointer.