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_info	Object instance of type transaction_information.
[out]	account_number	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to account_number.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	account_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_info	Value written of type transaction_information.
[out]	acq	Pointer to variable to write value to. Value is 0 if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to acq.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	acq 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_info	Object instance of type transaction_information.
[out]	acq_trans_ref	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to acq_trans_ref.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	acq_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_info	Object instance of type transaction_information.
[out]	auth_code	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to auth_code.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	auth_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_info	Object instance of type transaction_information.
[out]	card_id	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to card_id.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	card_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.

Deprecated:

Use ta_card_data_get_cardholder instead (on card_data object returned by ta_transaction_response_get_card_data).

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

Parameters

[in]	trx_info	Object instance of type transaction_information.
[out]	cardholder_name	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to cardholder_name.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	cardholder_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_info	Object instance of type transaction_information.
[out]	client_identifier	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to client_identifier.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	client_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_info	Value written of type transaction_information.
[out]	cvm	Pointer 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_ok	Object instance written to cvm.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	cvm 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_info	Object instance of type transaction_information.
[out]	merchant_action	Pointer 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_ok	Value written written to merchant_action.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	merchant_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_info	Object instance of type transaction_information.
[out]	ngv_used_flag	Pointer 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_ok	Value written to ngv_used_flag.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	ngv_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_info	Object instance of type transaction_information.
[out]	person_oid	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to person_oid.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	person_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_info	Object instance of type transaction_information.
[out]	pos_entry_mode	Pointer 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_ok	Value written to pos_entry_mode.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	pos_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_info	Object instance of type transaction_information.
[out]	signature_information	Pointer to variable to write object instance to. Object instance is of type signature_information and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to signature_information.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	signature_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_info	Object instance of type transaction_information.
[out]	six_trx_ref_num	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to six_trx_ref_num.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	six_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_info	Object instance of type transaction_information.
[out]	time_stamp	Pointer to variable to write object instance to. Object instance is of type timedate and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to time_stamp.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	time_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_info	Object instance of type transaction_information.
[out]	trans_ref	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to trans_ref.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	trans_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_info	Object instance of type transaction_information.
[out]	trans_seq	Pointer to variable to write object instance to. Object instance is of type integer and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to trans_seq.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	trans_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_info	Object instance of type transaction_information.
[out]	trm_trans_ref	Pointer to variable to write object instance to. Object instance is of type string and is not retained. Object instance is ta_object_invalid if value is not set in trx_info.

Return values

ta_c_rc_ok	Object instance written to trm_trans_ref.
ta_c_rc_invalid_argument	trx_info is ta_object_invalid.
ta_c_rc_invalid_argument	trx_info is not of type transaction_information.
ta_c_rc_invalid_argument	trm_trans_ref is null-pointer.