TIM SDK
TIM API C
transaction_information.h File Reference

Description

Transaction information.

Object type transaction_information.

Functions

ta_e_result_code_t ta_transaction_information_get_pos_entry_mode (ta_object_t trx_info, ta_e_pos_entry_mode_t *pos_entry_mode)
 According to EMV definition. More...
 
ta_e_result_code_t ta_transaction_information_get_cvm (ta_object_t trx_info, ta_e_cvm_t *cvm)
 Cardholder verification method. More...
 
ta_e_result_code_t ta_transaction_information_get_merchant_action (ta_object_t trx_info, ta_e_merchant_action_t *merchant_action)
 Feedback to know which merchant action has to be performed. More...
 
ta_e_result_code_t ta_transaction_information_get_auth_code (ta_object_t trx_info, ta_object_t *auth_code)
 Authorization code received from the acquirer. More...
 
ta_e_result_code_t ta_transaction_information_get_time_stamp (ta_object_t trx_info, ta_object_t *time_stamp)
 Local time of the transaction. More...
 
ta_e_result_code_t ta_transaction_information_get_trans_ref (ta_object_t trx_info, ta_object_t *trans_ref)
 Transaction reference defined by the terminal. More...
 
ta_e_result_code_t ta_transaction_information_get_trans_seq (ta_object_t trx_info, ta_object_t *trans_seq)
 Transaction sequence number defined by the terminal. More...
 
ta_e_result_code_t ta_transaction_information_get_acq (ta_object_t trx_info, int *acq)
 TransactionAcquirer identifier. More...
 
ta_e_result_code_t ta_transaction_information_get_signature_information (ta_object_t trx_info, ta_object_t *signature_information)
 Signature captured by EFT Terminal if present. More...
 
ta_e_result_code_t ta_transaction_information_get_trm_trans_ref (ta_object_t trx_info, ta_object_t *trm_trans_ref)
 Transaction reference from the terminal. More...
 
ta_e_result_code_t ta_transaction_information_get_acq_trans_ref (ta_object_t trx_info, ta_object_t *acq_trans_ref)
 Transaction reference from the acquirer. More...
 
ta_e_result_code_t ta_transaction_information_get_six_trx_ref_num (ta_object_t trx_info, ta_object_t *six_trx_ref_num)
 SIX Transaction Reference. More...
 
ta_e_result_code_t ta_transaction_information_get_cardholder_name (ta_object_t trx_info, ta_object_t *cardholder_name)
 Cardholder name. More...
 
ta_e_result_code_t ta_transaction_information_get_client_identifier (ta_object_t trx_info, ta_object_t *client_identifier)
 Cardholder ID- or Passport number. More...
 
ta_e_result_code_t ta_transaction_information_get_account_number (ta_object_t trx_info, ta_object_t *account_number)
 Account number of the card used. More...
 
ta_e_result_code_t ta_transaction_information_get_person_oid (ta_object_t trx_info, ta_object_t *person_oid)
 Person OID. More...
 
ta_e_result_code_t ta_transaction_information_get_card_id (ta_object_t trx_info, ta_object_t *card_id)
 Card ID. More...
 
ta_e_result_code_t ta_transaction_information_get_ngv_used_flag (ta_object_t trx_info, ta_e_boolean_t *ngv_used_flag)
 Indicates if a transaction was performed as non guaranteed payment (NGV). More...
 

Function Documentation

◆ ta_transaction_information_get_account_number()

ta_e_result_code_t ta_transaction_information_get_account_number ( ta_object_t  trx_info,
ta_object_t account_number 
)

Account number of the card used.

Optional: Mandatory if requested by acquirer. Specifications: Banking, AustrianUseCases.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]account_numberPointer 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_info.
Return values
ta_c_rc_okObject instance written to account_number.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentaccount_number is null-pointer.

◆ ta_transaction_information_get_acq()

ta_e_result_code_t ta_transaction_information_get_acq ( ta_object_t  trx_info,
int *  acq 
)

TransactionAcquirer identifier.

Parameters
[in]trx_infoValue written of type transaction_information.
[out]acqPointer to variable to write value to. Value is 0 if value is not set in trx_info.
Return values
ta_c_rc_okObject instance written to acq.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentacq is null-pointer.

◆ ta_transaction_information_get_acq_trans_ref()

ta_e_result_code_t ta_transaction_information_get_acq_trans_ref ( ta_object_t  trx_info,
ta_object_t acq_trans_ref 
)

Transaction reference from the acquirer.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]acq_trans_refPointer 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_info.
Return values
ta_c_rc_okObject instance written to acq_trans_ref.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentacq_trans_ref is null-pointer.

◆ ta_transaction_information_get_auth_code()

ta_e_result_code_t ta_transaction_information_get_auth_code ( ta_object_t  trx_info,
ta_object_t auth_code 
)

Authorization code received from the acquirer.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]auth_codePointer 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_info.
Return values
ta_c_rc_okObject instance written to auth_code.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentauth_code is null-pointer.

◆ ta_transaction_information_get_card_id()

ta_e_result_code_t ta_transaction_information_get_card_id ( ta_object_t  trx_info,
ta_object_t card_id 
)

Card ID.

Optional: Mandatory if requested by acquirer. Specifications: Banking, AustrianUseCases.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]card_idPointer 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_info.
Return values
ta_c_rc_okObject instance written to card_id.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentcard_id is null-pointer.

◆ ta_transaction_information_get_cardholder_name()

ta_e_result_code_t ta_transaction_information_get_cardholder_name ( ta_object_t  trx_info,
ta_object_t cardholder_name 
)

Cardholder name.

Optional: Mandatory if requested by acquirer. Specifications: Banking, AustrianUseCases.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]cardholder_namePointer 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_info.
Return values
ta_c_rc_okObject instance written to cardholder_name.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentcardholder_name is null-pointer.

◆ ta_transaction_information_get_client_identifier()

ta_e_result_code_t ta_transaction_information_get_client_identifier ( ta_object_t  trx_info,
ta_object_t client_identifier 
)

Cardholder ID- or Passport number.

Optional: Mandatory if requested by acquirer. Specifications: Banking, AustrianUseCases.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]client_identifierPointer 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_info.
Return values
ta_c_rc_okObject instance written to client_identifier.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentclient_identifier is null-pointer.

◆ ta_transaction_information_get_cvm()

ta_e_result_code_t ta_transaction_information_get_cvm ( ta_object_t  trx_info,
ta_e_cvm_t cvm 
)

Cardholder verification method.

Parameters
[in]trx_infoValue written of type transaction_information.
[out]cvmPointer to variable to write value to. Value is ta_c_cvm_undefined if value is not set in trx_info.
Return values
ta_c_rc_okObject instance written to cvm.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentcvm is null-pointer.

◆ ta_transaction_information_get_merchant_action()

ta_e_result_code_t ta_transaction_information_get_merchant_action ( ta_object_t  trx_info,
ta_e_merchant_action_t merchant_action 
)

Feedback to know which merchant action has to be performed.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]merchant_actionPointer to variable to write value to. Value is ta_c_ma_undefined if value is not set in trx_info.
Return values
ta_c_rc_okValue written written to merchant_action.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentmerchant_action is null-pointer.

◆ ta_transaction_information_get_ngv_used_flag()

ta_e_result_code_t ta_transaction_information_get_ngv_used_flag ( ta_object_t  trx_info,
ta_e_boolean_t ngv_used_flag 
)

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

Available if AustrianUseCases is enabled.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]ngv_used_flagPointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_info.
Return values
ta_c_rc_okValue written to ngv_used_flag.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentngv_used_flag is null-pointer.

◆ ta_transaction_information_get_person_oid()

ta_e_result_code_t ta_transaction_information_get_person_oid ( ta_object_t  trx_info,
ta_object_t person_oid 
)

Person OID.

Optional: Mandatory if requested by acquirer. Specifications: Banking, AustrianUseCases.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]person_oidPointer 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_info.
Return values
ta_c_rc_okObject instance written to person_oid.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentperson_oid is null-pointer.

◆ ta_transaction_information_get_pos_entry_mode()

ta_e_result_code_t ta_transaction_information_get_pos_entry_mode ( ta_object_t  trx_info,
ta_e_pos_entry_mode_t pos_entry_mode 
)

According to EMV definition.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]pos_entry_modePointer to variable to write value to. Value is ta_c_pem_undefined if value is not set in trx_info.
Return values
ta_c_rc_okValue written to pos_entry_mode.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentpos_entry_mode is null-pointer.

◆ ta_transaction_information_get_signature_information()

ta_e_result_code_t ta_transaction_information_get_signature_information ( ta_object_t  trx_info,
ta_object_t signature_information 
)

Signature captured by EFT Terminal if present.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]signature_informationPointer to variable to write object instance to. Object instance is of type signature_information and is not retained. Object instance is ta_invalid_object if value is not set in trx_info.
Return values
ta_c_rc_okObject instance written to signature_information.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentsignature_information is null-pointer.

◆ ta_transaction_information_get_six_trx_ref_num()

ta_e_result_code_t ta_transaction_information_get_six_trx_ref_num ( ta_object_t  trx_info,
ta_object_t six_trx_ref_num 
)

SIX Transaction Reference.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]six_trx_ref_numPointer 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_info.
Return values
ta_c_rc_okObject instance written to six_trx_ref_num.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumentsix_trx_ref_num is null-pointer.

◆ ta_transaction_information_get_time_stamp()

ta_e_result_code_t ta_transaction_information_get_time_stamp ( ta_object_t  trx_info,
ta_object_t time_stamp 
)

Local time of the transaction.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]time_stampPointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_invalid_object if value is not set in trx_info.
Return values
ta_c_rc_okObject instance written to time_stamp.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumenttime_stamp is null-pointer.

◆ ta_transaction_information_get_trans_ref()

ta_e_result_code_t ta_transaction_information_get_trans_ref ( ta_object_t  trx_info,
ta_object_t trans_ref 
)

Transaction reference defined by the terminal.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]trans_refPointer 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_info.
Return values
ta_c_rc_okObject instance written to trans_ref.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumenttrans_ref is null-pointer.

◆ ta_transaction_information_get_trans_seq()

ta_e_result_code_t ta_transaction_information_get_trans_seq ( ta_object_t  trx_info,
ta_object_t trans_seq 
)

Transaction sequence number defined by the terminal.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]trans_seqPointer 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_info.
Return values
ta_c_rc_okObject instance written to trans_seq.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumenttrans_seq is null-pointer.

◆ ta_transaction_information_get_trm_trans_ref()

ta_e_result_code_t ta_transaction_information_get_trm_trans_ref ( ta_object_t  trx_info,
ta_object_t trm_trans_ref 
)

Transaction reference from the terminal.

Parameters
[in]trx_infoObject instance of type transaction_information.
[out]trm_trans_refPointer 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_info.
Return values
ta_c_rc_okObject instance written to trm_trans_ref.
ta_c_rc_invalid_argumenttrx_info is ta_invalid_object.
ta_c_rc_invalid_argumenttrx_info is not of type transaction_information.
ta_c_rc_invalid_argumenttrm_trans_ref is null-pointer.