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]	aid	Object instance of type string.
[out]	aid	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to aid.
ta_c_rc_invalid_argument	aid is ta_invalid_object.
ta_c_rc_invalid_argument	aid is not of type string.
ta_c_rc_invalid_argument	aid 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_detail	Object instance of type trx_detail.
[out]	amount_sum	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	amount_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_detail	Object instance of type trx_detail.
[out]	amount_sum	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	amount_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_detail	Object instance of type trx_detail.
[out]	amount_sum	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to amount_sum.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	amount_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_detail	Object instance of type trx_detail.
[out]	count	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to count.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	count 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_detail	Object instance of type trx_detail.
[out]	dcc_flag	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to dcc_flag.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	dcc_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]	markup	Object instance of type integer.
[out]	markup	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to markup.
ta_c_rc_invalid_argument	markup is ta_invalid_object.
ta_c_rc_invalid_argument	markup is not of type integer.
ta_c_rc_invalid_argument	markup 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_exponent	Object instance of type integer.
[out]	markup_exponent	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 trx_detail.

Return values

ta_c_rc_ok	Object instance written to markup_exponent.
ta_c_rc_invalid_argument	markup_exponent is ta_invalid_object.
ta_c_rc_invalid_argument	markup_exponent is not of type integer.
ta_c_rc_invalid_argument	markup_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_detail	Object instance of type trx_detail.
[out]	ngvused	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to dcc_flag.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	ngvused 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_detail	Object instance of type trx_detail.
[out]	transaction_type	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to transaction_type.
ta_c_rc_invalid_argument	trx_detail is ta_invalid_object.
ta_c_rc_invalid_argument	trx_detail is not of type trx_detail.
ta_c_rc_invalid_argument	transaction_type is null-pointer.