TIM SDK
TIM API C
trx_detail.h File Reference

Description

Contains transaction details for counters.

Object type trx_detail.

Functions

ta_e_result_code_t ta_trx_detail_get_dcc_flag (ta_object_t trx_detail, ta_e_boolean_t *dcc_flag)
 Specifies is a transaction is a DCC transaction or not. More...
 
ta_e_result_code_t ta_trx_detail_get_transaction_type (ta_object_t trx_detail, ta_e_transaction_type_t *transaction_type)
 Transaction type this details affect. More...
 
ta_e_result_code_t ta_trx_detail_get_count (ta_object_t trx_detail, int *count)
 Number of transactions covered by the sum. More...
 
ta_e_result_code_t ta_trx_detail_get_amount_sum (ta_object_t trx_detail, ta_object_t *amount_sum)
 Total of amount. More...
 
ta_e_result_code_t ta_trx_detail_get_amount_sum_tip (ta_object_t trx_detail, ta_object_t *amount_sum)
 Total of tip amount. More...
 
ta_e_result_code_t ta_trx_detail_get_amount_sum_other (ta_object_t trx_detail, ta_object_t *amount_sum)
 Total of other amount. More...
 
ta_e_result_code_t ta_trx_detail_get_aid (ta_object_t trx_detail, ta_object_t *aid)
 AID. More...
 
ta_e_result_code_t ta_trx_detail_get_markup (ta_object_t trx_detail, ta_object_t *markup)
 Markup percentage value. More...
 
ta_e_result_code_t ta_trx_detail_get_markup_exponent (ta_object_t trx_detail, ta_object_t *markup_exponent)
 Markup percentage value exponent. More...
 
ta_e_result_code_t ta_trx_detail_get_ngvused_flag (ta_object_t trx_detail, ta_e_boolean_t *ngvused)
 Indicates if a transaction was performed as non guaranteed payment (NGV). More...
 

Function Documentation

◆ ta_trx_detail_get_aid()

ta_e_result_code_t ta_trx_detail_get_aid ( ta_object_t  trx_detail,
ta_object_t aid 
)

AID.

Parameters
[in]aidObject instance of type string.
[out]aidPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to aid.
ta_c_rc_invalid_argumentaid is ta_invalid_object.
ta_c_rc_invalid_argumentaid is not of type string.
ta_c_rc_invalid_argumentaid is null-pointer.

◆ ta_trx_detail_get_amount_sum()

ta_e_result_code_t ta_trx_detail_get_amount_sum ( ta_object_t  trx_detail,
ta_object_t amount_sum 
)

Total of amount.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]amount_sumPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to amount_sum.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentamount_sum is null-pointer.

◆ ta_trx_detail_get_amount_sum_other()

ta_e_result_code_t ta_trx_detail_get_amount_sum_other ( ta_object_t  trx_detail,
ta_object_t amount_sum 
)

Total of other amount.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]amount_sumPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to amount_sum.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentamount_sum is null-pointer.

◆ ta_trx_detail_get_amount_sum_tip()

ta_e_result_code_t ta_trx_detail_get_amount_sum_tip ( ta_object_t  trx_detail,
ta_object_t amount_sum 
)

Total of tip amount.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]amount_sumPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to amount_sum.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentamount_sum is null-pointer.

◆ ta_trx_detail_get_count()

ta_e_result_code_t ta_trx_detail_get_count ( ta_object_t  trx_detail,
int *  count 
)

Number of transactions covered by the sum.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]countPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to count.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentcount is null-pointer.

◆ ta_trx_detail_get_dcc_flag()

ta_e_result_code_t ta_trx_detail_get_dcc_flag ( ta_object_t  trx_detail,
ta_e_boolean_t dcc_flag 
)

Specifies is a transaction is a DCC transaction or not.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]dcc_flagPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to dcc_flag.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentdcc_flag is null-pointer.

◆ ta_trx_detail_get_markup()

ta_e_result_code_t ta_trx_detail_get_markup ( ta_object_t  trx_detail,
ta_object_t markup 
)

Markup percentage value.

Parameters
[in]markupObject instance of type integer.
[out]markupPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to markup.
ta_c_rc_invalid_argumentmarkup is ta_invalid_object.
ta_c_rc_invalid_argumentmarkup is not of type integer.
ta_c_rc_invalid_argumentmarkup is null-pointer.

◆ ta_trx_detail_get_markup_exponent()

ta_e_result_code_t ta_trx_detail_get_markup_exponent ( ta_object_t  trx_detail,
ta_object_t markup_exponent 
)

Markup percentage value exponent.

Parameters
[in]markup_exponentObject instance of type integer.
[out]markup_exponentPointer 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 trx_detail.
Return values
ta_c_rc_okObject instance written to markup_exponent.
ta_c_rc_invalid_argumentmarkup_exponent is ta_invalid_object.
ta_c_rc_invalid_argumentmarkup_exponent is not of type integer.
ta_c_rc_invalid_argumentmarkup_exponent is null-pointer.

◆ ta_trx_detail_get_ngvused_flag()

ta_e_result_code_t ta_trx_detail_get_ngvused_flag ( ta_object_t  trx_detail,
ta_e_boolean_t ngvused 
)

Indicates if a transaction was performed as non guaranteed payment (NGV).

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]ngvusedPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to dcc_flag.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumentngvused is null-pointer.

◆ ta_trx_detail_get_transaction_type()

ta_e_result_code_t ta_trx_detail_get_transaction_type ( ta_object_t  trx_detail,
ta_e_transaction_type_t transaction_type 
)

Transaction type this details affect.

Parameters
[in]trx_detailObject instance of type trx_detail.
[out]transaction_typePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to transaction_type.
ta_c_rc_invalid_argumenttrx_detail is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_detail is not of type trx_detail.
ta_c_rc_invalid_argumenttransaction_type is null-pointer.