TIM SDK
TIM API C
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, int *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,
int *  acq_id 
)

Acquirer identifier. Uniquely identifies the acquirer.

Parameters
[in]counterObject instance of type counter.
[out]acq_idPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to acq_id.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentacq_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]counterObject instance of type counter.
[out]brand_namePointer to variable to write object instance to. Object instance is of type string and is not retained.
Return values
ta_c_rc_okObject instance written to brand_name.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentbrand_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]counterObject instance of type counter.
[out]countPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to count.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentcount 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]counterObject instance of type counter.
[out]count_dccPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to count_dcc.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentcount_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]counterObject instance of type counter.
[out]count_foreignPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to count_foreign.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentcount_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]counterObject instance of type counter.
[out]payment_protocolPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to payment_protocol.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumentpayment_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]counterObject instance of type counter.
[out]totalsPointer 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_okObject instance written to totals.
ta_c_rc_invalid_argumentcounter is ta_invalid_object.
ta_c_rc_invalid_argumentcounter is not of type counter.
ta_c_rc_invalid_argumenttotals is null-pointer.