TIM SDK
TIM API C
|
|
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... | |
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.
[in] | response | Object instance of type transaction_response. |
[out] | country_code | Pointer 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. |
ta_c_rc_ok | Object instance written to country_code. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | country_code is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_additional_info | ( | ta_object_t | response, |
ta_object_t * | additional_info | ||
) |
Additional information list.
[in] | response | Object instance of type transaction_response. |
[out] | additional_info | Pointer 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. |
ta_c_rc_ok | Object instance written to additional_info. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | additional_info is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_amount | ( | ta_object_t | response, |
ta_object_t * | amount | ||
) |
Amount.
[in] | response | Object instance of type transaction_response. |
[out] | amount | Pointer 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. |
ta_c_rc_ok | Object instance written to amount. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | amount_dcc | Pointer 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. |
ta_c_rc_ok | Object instance written to amount_dcc. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount_dcc is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | amount_due | Pointer 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. |
ta_c_rc_ok | Object instance written to amount_due. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount_due is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_amount_loyalty_cashback | ( | ta_object_t | response, |
ta_object_t * | amount | ||
) |
Loyalty cashback amount.
[in] | response | Object instance of type transaction_response. |
[out] | amount | Pointer 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. |
ta_c_rc_ok | Object instance written to basket. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_amount_other | ( | ta_object_t | response, |
ta_object_t * | amount_other | ||
) |
Other amount in the transaction.
[in] | response | Object instance of type transaction_response. |
[out] | amount_other | Pointer 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. |
ta_c_rc_ok | Object instance written to amount_other. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount_other is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_amount_saldo | ( | ta_object_t | response, |
ta_object_t * | amount_saldo | ||
) |
Saldo amount if present.
[in] | response | Object instance of type transaction_response. |
[out] | amount_saldo | Pointer 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. |
ta_c_rc_ok | Object instance written to amount_saldo. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount_saldo is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | amount_due | Pointer 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. |
ta_c_rc_ok | Object instance written to amount_due. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | amount_due is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_basket | ( | ta_object_t | response, |
ta_object_t * | basket | ||
) |
Petrol: Basket.
[in] | response | Object instance of type transaction_response. |
[out] | basket | Pointer 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. |
ta_c_rc_ok | Object instance written to basket. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | basket is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | card_data | Pointer 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. |
ta_c_rc_ok | Object instance written to card_data. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | card_data is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_dcc_disclaimer | ( | ta_object_t | response, |
ta_object_t * | dcc_disclaimer | ||
) |
Disclaimer sent by host.
[in] | response | Object instance of type transaction_response. |
[out] | dcc_disclaimer | Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_invalid_object if value is not set in response. |
ta_c_rc_ok | Object instance written to dcc_disclaimer. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | dcc_disclaimer is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | print_data | Pointer 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. |
ta_c_rc_ok | Object instance written to print_data. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | print_data is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_transaction_information | ( | ta_object_t | response, |
ta_object_t * | transaction_information | ||
) |
Information about completed transaction.
[in] | response | Object instance of type transaction_response. |
[out] | transaction_information | Pointer 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. |
ta_c_rc_ok | Object instance written to transaction_information. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | transaction_information is null-pointer. |
ta_e_result_code_t ta_transaction_response_get_type | ( | ta_object_t | response, |
ta_e_transaction_type_t * | type | ||
) |
Transaction type.
[in] | response | Object instance of type transaction_response. |
[out] | type | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to type. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | type is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | is_domestic | Pointer 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. |
ta_c_rc_ok | Value written to is_domestic. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | is_domestic is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | needs_action | Pointer to variable to write value to. |
ta_c_rc_ok | Value written to needs_action. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | needs_action is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | country_code | Pointer 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. |
ta_c_rc_ok | Object instance written to country_code. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | country_code is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | was_dcc | Pointer to variable to write value to. Set to ta_c_b_true if transaction has been using DCC. |
ta_c_rc_ok | Value written to was_dcc. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | was_dcc is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | was_partial_approved | Pointer to variable to write value to. Set to ta_c_b_true if transaction has been partially approved. |
ta_c_rc_ok | Value written to was_partial_approved. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | was_partial_approved is null-pointer. |
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.
[in] | response | Object instance of type transaction_response. |
[out] | was_tip | Pointer to variable to write value to. Set to ta_c_b_true if transaction has been using TIP. |
ta_c_rc_ok | Value written to was_tip. |
ta_c_rc_invalid_argument | response is ta_invalid_object. |
ta_c_rc_invalid_argument | response is not of type transaction_response. |
ta_c_rc_invalid_argument | was_tip is null-pointer. |