TIM SDK
TIM API C
brand.h File Reference

Description

Contains information about a brand available on the terminal.

Object type brand.

It is available after ta_terminal_login() or ta_terminal_login_async has been performed or brands have been manually retrieved by ta_terminal_application_information() or ta_terminal_application_information_async().

Functions

ta_e_result_code_t ta_brand_get_name (ta_object_t brand, ta_object_t *name)
 Brand name of a card. More...
 
ta_e_result_code_t ta_brand_get_dcc_available (ta_object_t brand, ta_e_boolean_t *dcc_available)
 DCC is available for this brand. More...
 
ta_e_result_code_t ta_brand_get_payment_protocol (ta_object_t brand, ta_e_payment_protocol_t *payment_protocol)
 Payment protocol used. More...
 
ta_e_result_code_t ta_brand_get_acq_id (ta_object_t brand, int *acq_id)
 Acquirer identifier. Uniquely identifies the acquirer. More...
 
ta_e_result_code_t ta_brand_get_last_init_date (ta_object_t brand, ta_object_t *last_init_date)
 Last time a defined acquirer was successfully initialized on the terminal. More...
 
ta_e_result_code_t ta_brand_get_applications (ta_object_t brand, ta_object_t *applications)
 List of applications supported by the brand. More...
 
ta_e_result_code_t ta_brand_get_currencies (ta_object_t brand, ta_object_t *currencies)
 List of currencies supported by the brand. More...
 

Function Documentation

◆ ta_brand_get_acq_id()

ta_e_result_code_t ta_brand_get_acq_id ( ta_object_t  brand,
int *  acq_id 
)

Acquirer identifier. Uniquely identifies the acquirer.

Parameters
[in]brandObject instance of type brand.
[out]acq_idPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to acq_id.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentacq_id is null-pointer.

◆ ta_brand_get_applications()

ta_e_result_code_t ta_brand_get_applications ( ta_object_t  brand,
ta_object_t applications 
)

List of applications supported by the brand.

Parameters
[in]brandObject instance of type brand.
[out]applicationsPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type application.
Return values
ta_c_rc_okObject instance written to applications.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentapplications is null-pointer.

◆ ta_brand_get_currencies()

ta_e_result_code_t ta_brand_get_currencies ( ta_object_t  brand,
ta_object_t currencies 
)

List of currencies supported by the brand.

Parameters
[in]brandObject instance of type brand.
[out]currenciesPointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type currency_item.
Return values
ta_c_rc_okObject instance written to currencies.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentcurrencies is null-pointer.

◆ ta_brand_get_dcc_available()

ta_e_result_code_t ta_brand_get_dcc_available ( ta_object_t  brand,
ta_e_boolean_t dcc_available 
)

DCC is available for this brand.

Parameters
[in]brandObject instance of type brand.
[out]dcc_availablePointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to dcc_available.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentdcc_available is null-pointer.

◆ ta_brand_get_last_init_date()

ta_e_result_code_t ta_brand_get_last_init_date ( ta_object_t  brand,
ta_object_t last_init_date 
)

Last time a defined acquirer was successfully initialized on the terminal.

Parameters
[in]brandObject instance of type brand.
[out]last_init_datePointer to variable to write object instance to. Object instance is of type timedate and is not retained.
Return values
ta_c_rc_okObject instance written to last_init_date.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentlast_init_date is null-pointer.

◆ ta_brand_get_name()

ta_e_result_code_t ta_brand_get_name ( ta_object_t  brand,
ta_object_t name 
)

Brand name of a card.

Parameters
[in]brandObject instance of type brand.
[out]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 name.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentname is null-pointer.

◆ ta_brand_get_payment_protocol()

ta_e_result_code_t ta_brand_get_payment_protocol ( ta_object_t  brand,
ta_e_payment_protocol_t payment_protocol 
)

Payment protocol used.

Parameters
[in]brandObject instance of type brand.
[out]payment_protocolPointer to variable to write value to.
Return values
ta_c_rc_okObject instance written to payment_protocol.
ta_c_rc_invalid_argumentbrand is ta_invalid_object.
ta_c_rc_invalid_argumentbrand is not of type brand.
ta_c_rc_invalid_argumentpayment_protocol is null-pointer.