counter.h File Reference

Description

Contains information about a counter for a brand.

Object type counter.

Functions
ta_e_result_code_t	ta_counter_get_brand_name (ta_object_t counter, ta_object_t *brand_name)
	Name of brand the counter contains information for. More...
ta_e_result_code_t	ta_counter_get_payment_protocol (ta_object_t counter, ta_e_payment_protocol_t *payment_protocol)
	Payment protocol linked to the brand. More...
ta_e_result_code_t	ta_counter_get_acq_id (ta_object_t counter, int64_t *acq_id)
	Acquirer identifier. Uniquely identifies the acquirer. More...
ta_e_result_code_t	ta_counter_get_count (ta_object_t counter, int *count)
	Counter number of transactions. More...
ta_e_result_code_t	ta_counter_get_count_dcc (ta_object_t counter, int *count_dcc)
	Number of DCC related transactions. More...
ta_e_result_code_t	ta_counter_get_count_foreign (ta_object_t counter, int *count_foreign)
	Number of foreign currency related transactions. More...
ta_e_result_code_t	ta_counter_get_totals (ta_object_t counter, ta_object_t *totals)
	Number of totals to break down the counter amount in more detail. More...

Function Documentation

ta_counter_get_acq_id()

ta_e_result_code_t ta_counter_get_acq_id	(	ta_object_t	counter,
		int64_t *	acq_id
	)

Acquirer identifier. Uniquely identifies the acquirer.

Parameters

[in]	counter	Object instance of type counter.
[out]	acq_id	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to acq_id.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	acq_id is null-pointer.

ta_counter_get_brand_name()

ta_e_result_code_t ta_counter_get_brand_name	(	ta_object_t	counter,
		ta_object_t *	brand_name
	)

Name of brand the counter contains information for.

Parameters

[in]	counter	Object instance of type counter.
[out]	brand_name	Pointer to variable to write object instance to. Object instance is of type string and is not retained.

Return values

ta_c_rc_ok	Object instance written to brand_name.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	brand_name is null-pointer.

ta_counter_get_count()

ta_e_result_code_t ta_counter_get_count	(	ta_object_t	counter,
		int *	count
	)

Counter number of transactions.

Parameters

[in]	counter	Object instance of type counter.
[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	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	count is null-pointer.

ta_counter_get_count_dcc()

ta_e_result_code_t ta_counter_get_count_dcc	(	ta_object_t	counter,
		int *	count_dcc
	)

Number of DCC related transactions.

Parameters

[in]	counter	Object instance of type counter.
[out]	count_dcc	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to count_dcc.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	count_dcc is null-pointer.

ta_counter_get_count_foreign()

ta_e_result_code_t ta_counter_get_count_foreign	(	ta_object_t	counter,
		int *	count_foreign
	)

Number of foreign currency related transactions.

Parameters

[in]	counter	Object instance of type counter.
[out]	count_foreign	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to count_foreign.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	count_foreign is null-pointer.

ta_counter_get_payment_protocol()

ta_e_result_code_t ta_counter_get_payment_protocol	(	ta_object_t	counter,
		ta_e_payment_protocol_t *	payment_protocol
	)

Payment protocol linked to the brand.

Parameters

[in]	counter	Object instance of type counter.
[out]	payment_protocol	Pointer to variable to write value to.

Return values

ta_c_rc_ok	Object instance written to payment_protocol.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	payment_protocol is null-pointer.

ta_counter_get_totals()

ta_e_result_code_t ta_counter_get_totals	(	ta_object_t	counter,
		ta_object_t *	totals
	)

Number of totals to break down the counter amount in more detail.

Parameters

[in]	counter	Object instance of type counter.
[out]	totals	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type total.

Return values

ta_c_rc_ok	Object instance written to totals.
ta_c_rc_invalid_argument	counter is ta_object_invalid.
ta_c_rc_invalid_argument	counter is not of type counter.
ta_c_rc_invalid_argument	totals is null-pointer.