TIM SDK
TIM API C
|
|
Transaction data.
Object type transaction_data.
ta_e_result_code_t ta_transaction_data_copy | ( | ta_object_t * | trx_data, |
const ta_object_t * | source_trx_data | ||
) |
Create copy of transaction data.
[out] | trx_data | Pointer to variable to write created object instance to. Created object instance is retained. |
[in] | source_trx_data | Object of type transaction_data to create copy of. |
ta_c_rc_ok | Object instance has been created and written to trx_data. |
ta_c_rc_invalid_argument | trx_data is null-pointer. |
ta_c_rc_invalid_argument | source_trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | source_trx_data is not of type transaction_data. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_transaction_data_create | ( | ta_object_t * | trx_data | ) |
Create transaction data.
[out] | trx_data | Pointer to variable to write created object instance to. Created object instance is retained. |
ta_c_rc_ok | Object instance has been created and written to trx_data. |
ta_c_rc_invalid_argument | trx_data is null-pointer. |
ta_c_rc_out_of_memory | Failed allocating memory. |
ta_e_result_code_t ta_transaction_data_get_acq_id | ( | ta_object_t | trx_data, |
ta_object_t * | acq_id | ||
) |
Acquirer identifier. Uniquely identifies the acquirer.
[in] | trx_data | Object instance of type transaction_data. |
[out] | acq_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_data. |
ta_c_rc_ok | Object instance written to acq_id. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | acq_id is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_acq_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t * | acq_trans_ref | ||
) |
Transaction reference from the acquirer.
[in] | trx_data | Object instance of type transaction_data. |
[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_data. |
ta_c_rc_ok | Object instance written to acq_trans_ref. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | acq_trans_ref is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_age_to_check | ( | ta_object_t | trx_data, |
ta_object_t * | age_to_check | ||
) |
Age to check.
[in] | trx_data | Object instance of type transaction_data. |
[out] | age_to_check | 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. |
ta_c_rc_ok | Object instance written to merchant_id. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | age_to_check is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_allowed_accounts | ( | ta_object_t | trx_data, |
ta_object_t * | allowed_accounts | ||
) |
Allowed accounts (flags).
[in] | trx_data | Object instance of type transaction_data. |
[out] | allowed_accounts | Pointer to variable to write object instance to. Object instance is of type integer with value OR-combined from constant allowed_accounts. Object instance is not retained. Object instance is ta_object_invalid if value is not set in trx_data. |
ta_c_rc_ok | Object instance written to allowed_accounts. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | allowed_accounts is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_app_expiration_date | ( | ta_object_t | trx_data, |
ta_object_t * | app_expiration_date | ||
) |
Application expiration date.
Each application on a card has a corresponding expiration date and can be read from the card. Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118
[in] | trx_data | Object instance of type transaction_data. |
[out] | app_expiration_date | 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_data. |
ta_c_rc_ok | Object instance written to app_expiration_date. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | app_expiration_date is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_card_ref | ( | ta_object_t | trx_data, |
ta_object_t * | card_ref | ||
) |
Petrol: Reference from the card.
[in] | trx_data | Object instance of type transaction_data. |
[out] | card_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_data. |
ta_c_rc_ok | Object instance written to card_ref. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | card_ref is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_cvc2 | ( | ta_object_t | trx_data, |
ta_object_t * | cvc2 | ||
) |
Card verification code 2.
The card verification code 2 is used for transactions with MPKE as an additional security element that has to be provided. It has an n3 value: Numeric 3 digits: 012
[in] | trx_data | Object instance of type transaction_data. |
[out] | cvc2 | 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_data. |
ta_c_rc_ok | Value written to ngv_clearing_delay. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | cvc2 is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_dcc_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | dcc_allowed | ||
) |
Allows the EFT Terminal to enable DCC function.
[in] | trx_data | Object instance of type transaction_data. |
[out] | dcc_allowed | Pointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to dcc_allowed. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | dcc_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_deferred_auth_ind | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | deferred_auth_ind | ||
) |
Indicates that the transaction shall be performed using deffered authorisation.
The following values are valid: true: Deferred authorisation applies false: Standard authorisation scheme (default)
[in] | trx_data | Object instance of type transaction_data. |
[out] | deferred_auth_ind | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to deferred_auth_ind. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | deferred_auth_ind is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_ecr_seq_counter | ( | ta_object_t | trx_data, |
ta_object_t * | ecr_seq_counter | ||
) |
ECR sequence counter.
[in] | trx_data | Object instance of type transaction_data. |
[out] | ecr_seq_counter | 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_data. |
ta_c_rc_ok | Object instance written to ecr_seq_counter. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ecr_seq_counter is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_installment_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | installment_allowed | ||
) |
Indicates if installment shall be allowed for a transaction.
This tag can be set for each transaction separately to specifically allow or disallow installment feature during the corresponding transaction. As this is a boolean value is can be understood as follows: true: Installment is allowed for the transaction false: Installment is NOT allowed for the transaction
[in] | trx_data | Object instance of type transaction_data. |
[out] | installment_allowed | Pointer to variable to write value to. |
ta_c_rc_ok | Object instance written to installment_allowed. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | installment_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_language | ( | ta_object_t | trx_data, |
ta_object_t * | language | ||
) |
Petrol, Unattended: Language.
[in] | trx_data | Object instance of type transaction_data. |
[out] | language | 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_data. |
ta_c_rc_ok | Object instance written to language. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | language is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_multi_currency_flag | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | multi_currency_flag | ||
) |
Indicates if the transaction uses multiple currencies.
Optional: Indicates that the transaction uses multiple currencies. Specifications: Banking, Gastro, Hospitality,AustrianUseCases.
[in] | trx_data | Object instance of type transaction_data. |
[out] | multi_currency_flag | Pointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to multi_currency_flag. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | multi_currency_flag is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_ngv_clearing_delay | ( | ta_object_t | trx_data, |
int * | ngv_clearing_delay | ||
) |
Defines the clearing delay of the PurchaseNGV transaction.
Available if AustrianUseCases guide is enabled.
[in] | trx_data | Object instance of type transaction_data. |
[out] | ngv_clearing_delay | Pointer to variable to write value to. Value is 0 if value is not set in trx_data. |
ta_c_rc_ok | Value written to ngv_clearing_delay. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ngv_clearing_delay is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_ngv_mode | ( | ta_object_t | trx_data, |
ta_e_ngv_mode_t * | ngv_mode | ||
) |
Defines if NGV usage is mandatory or optional if card supports it.
Available if AustrianUseCases guide is enabled.
[in] | trx_data | Object instance of type transaction_data. |
[out] | ngv_mode | Pointer to variable to write value to. Value is ta_c_ngvm_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to ngv_mode. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ngv_mode is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_omnichannel_merchant_id | ( | ta_object_t | trx_data, |
ta_object_t * | merchant_id | ||
) |
The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host. This field is not used for Saferpay, but is for example for Ogone.
[in] | trx_data | Object instance of type transaction_data. |
[out] | merchant_id | 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 card_data. |
ta_c_rc_ok | Object instance written to merchant_id. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | merchant_id is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_omnichannel_payment_id | ( | ta_object_t | trx_data, |
ta_object_t * | payment_id | ||
) |
To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData. This attribute is also used to identify the Omnichannel host, a OmnichannelPaymentId starting by '90' meens for example that Ogone has to be used.
[in] | trx_data | Object instance of type transaction_data. |
[out] | payment_id | 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 card_data. |
ta_c_rc_ok | Object instance written to payment_id. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | payment_id is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_partial_approval_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | partial_approval_allowed | ||
) |
Partial approval is allowed.
[in] | trx_data | Object instance of type transaction_data. |
[out] | partial_approval_allowed | Pointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to partial_approval_allowed. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | partial_approval_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_phone_auth_code | ( | ta_object_t | trx_data, |
ta_object_t * | phone_auth_code | ||
) |
Phone authorization code.
[in] | trx_data | Object instance of type transaction_data. |
[out] | phone_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_data. |
ta_c_rc_ok | Object instance written to phone_auth_code. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | phone_auth_code is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_saferpay_alias | ( | ta_object_t | trx_data, |
ta_object_t * | saferpay_alias | ||
) |
Saferpay alias.
[in] | trx_data | Object instance of type transaction_data. |
[out] | saferpay_alias | 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_data. |
ta_c_rc_ok | Object instance written to saferpay_alias. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | saferpay_alias is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_saferpay_recurring | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | saferpay_recurring | ||
) |
Saferpay recurring enabled.
[in] | trx_data | Object instance of type transaction_data. |
[out] | saferpay_recurring | Pointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to saferpay_recurring. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | saferpay_recurring is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_six_trx_ref_num | ( | ta_object_t | trx_data, |
ta_object_t * | six_trx_ref_num | ||
) |
SIX Transaction Reference Number.
[in] | trx_data | Object instance of type transaction_data. |
[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_data. |
ta_c_rc_ok | Object instance written to six_trx_ref_num. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | six_trx_ref_num is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_sub_transactions | ( | ta_object_t | trx_data, |
ta_object_t * | sub_transactions | ||
) |
Sub transactions.
[in] | trx_data | Object instance of type transaction_data. |
[out] | sub_transactions | Pointer to variable to write object instance to. Object instance is of type list with elements of type sub_transaction. Object instance is not retained. Object instance is ta_object_invalid if value is not set in trx_data. |
ta_c_rc_ok | Object instance written to sub_transactions. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | sub_transactions is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_tip_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t * | tip_allowed | ||
) |
Tip is allowed for purchase transactions.
This parameter is only used if ta_c_g_gastro is enabled.
[in] | trx_data | Object instance of type transaction_data. |
[out] | tip_allowed | Pointer to variable to write value to. Value is ta_c_b_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to tip_allowed. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | tip_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_token_pan | ( | ta_object_t | trx_data, |
ta_object_t * | token_pan | ||
) |
Token PAN.
The token PAN is a tokenized version for an underlaying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host.
The TokenPan field is used in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR.
The TokenPan field always must be accompanied by a corresponding TokenPanType field.
[in] | trx_data | Object instance of type transaction_data. |
[out] | token_pan | 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 card_data. |
ta_c_rc_ok | Object instance written to token_pan. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | token_pan is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_token_pan_type | ( | ta_object_t | trx_data, |
ta_e_token_pan_type_t * | token_pan_type | ||
) |
Token PAN type.
To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.
The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone.
[in] | trx_data | Object instance of type transaction_data. |
[out] | token_pan_type | Pointer to variable to write value to. Value is ta_c_tpt_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to token_pan_type. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | token_pan_type is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t * | trans_ref | ||
) |
Transaction reference defined by the terminal.
[in] | trx_data | Object instance of type transaction_data. |
[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_data. |
ta_c_rc_ok | Object instance written to trans_ref. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trans_ref is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_trans_seq | ( | ta_object_t | trx_data, |
ta_object_t * | trans_seq | ||
) |
Transaction sequence number defined by the terminal.
[in] | trx_data | Object instance of type transaction_data. |
[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_data. |
ta_c_rc_ok | Object instance written to trans_seq. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trans_seq is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_transaction_reason | ( | ta_object_t | trx_data, |
ta_e_transaction_reason_t * | transaction_reason | ||
) |
Set the transaction reason to setup credential on file.
Available if AdvancedRetail guide is enabled.
[in] | trx_data | Object instance of type transaction_data. |
[out] | transaction_reason | Pointer to variable to write value to. Value is ta_c_ngvm_undefined if value is not set in trx_data. |
ta_c_rc_ok | Value written to transaction_reason. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | transaction_reason is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_trm_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t * | trm_trans_ref | ||
) |
Transaction reference from the terminal.
[in] | trx_data | Object instance of type transaction_data. |
[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_data. |
ta_c_rc_ok | Object instance written to trm_trans_ref. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trm_trans_ref is null-pointer. |
ta_e_result_code_t ta_transaction_data_get_trx_original_date | ( | ta_object_t | trx_data, |
ta_object_t * | trx_original_date | ||
) |
Timestamp of the original transaction.
[in] | trx_data | Object instance of type transaction_data. |
[out] | trx_original_date | 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_data. |
ta_c_rc_ok | Object instance written to trx_original_date. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trx_original_date is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_acq_id | ( | ta_object_t | trx_data, |
ta_object_t | acq_id | ||
) |
Set acquirer identifier. Uniquely identifies the acquirer.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | acq_id | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | acq_id is not ta_object_invalid and is not of type integer. |
ta_e_result_code_t ta_transaction_data_set_acq_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t | acq_trans_ref | ||
) |
Set transaction reference from the acquirer.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | acq_trans_ref | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | acq_trans_ref is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_age_to_check | ( | ta_object_t | trx_data, |
ta_object_t | age_to_check | ||
) |
Set age to check.
Mandatory for (can not be null):
Conditional for (can be null):
Forbidden (has to be always null):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | age_to_check | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | age_to_check is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_allowed_accounts | ( | ta_object_t | trx_data, |
ta_object_t | allowed_accounts | ||
) |
Set allowed accounts (flags).
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | allowed_accounts | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer with value OR-combined from constant allowed_accounts. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | allowed_accounts is not ta_object_invalid and is not of type list. |
ta_e_result_code_t ta_transaction_data_set_app_expiration_date | ( | ta_object_t | trx_data, |
ta_object_t | app_expiration_date | ||
) |
Set application expiration date.
Each application on a card has a corresponding expiration date and can be read from the card. Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | app_expiration_date | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type timedate. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | app_expiration_date is not ta_object_invalid and is not of type timedate. |
ta_e_result_code_t ta_transaction_data_set_card_ref | ( | ta_object_t | trx_data, |
ta_object_t | card_ref | ||
) |
Set petrol: Reference from the card.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | card_ref | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | card_ref is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_cvc2 | ( | ta_object_t | trx_data, |
ta_object_t | cvc2 | ||
) |
Set card verification code 2.
The card verification code 2 is used for transactions with MPKE as an additional security element that has to be provided. It has an n3 value: Numeric 3 digits: 012
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | cvc2 | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | cvc2 is null-pointer. |
ta_c_rc_invalid_argument | cvc2 is less than 0. |
ta_e_result_code_t ta_transaction_data_set_dcc_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t | dcc_allowed | ||
) |
Set allows the EFT Terminal to enable DCC function.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | dcc_allowed | Value to set. Value can be ta_c_b_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | dcc_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_deferred_auth_ind | ( | ta_object_t | trx_data, |
ta_e_boolean_t | installment_allowed | ||
) |
Set indicates that the transaction shall be performed using deffered authorisation.
The following values are valid: true: Deferred authorisation applies false: Standard authorisation scheme (default)
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | installment_allowed | Value to set. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | app_expiration_date is not ta_object_invalid and is not of type timedate. |
ta_e_result_code_t ta_transaction_data_set_ecr_seq_counter | ( | ta_object_t | trx_data, |
ta_object_t | ecr_seq_counter | ||
) |
Set ECR sequence counter.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | ecr_seq_counter | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ecr_seq_counter is not ta_object_invalid and is not of type integer. |
ta_e_result_code_t ta_transaction_data_set_installment_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t | installment_allowed | ||
) |
Set application expiration date.
Each application on a card has a corresponding expiration date and can be read from the card. Example: The format of an 'Expiration Date' is defined as MMyy, 2 digits for the month and 2 digits for the year. So January 2018 will have the following format as 'Expiration Date': 0118
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | installment_allowed | Value to set. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | app_expiration_date is not ta_object_invalid and is not of type timedate. |
ta_e_result_code_t ta_transaction_data_set_language | ( | ta_object_t | trx_data, |
ta_object_t | language | ||
) |
Set petrol, Unattended: Language.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | language | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | language is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_multi_currency_flag | ( | ta_object_t | trx_data, |
ta_e_boolean_t | multi_currency_flag | ||
) |
Set Indicates if the transaction uses multiple currencies.
Optional: Indicates that the transaction uses multiple currencies. Specifications: Banking, Gastro, Hospitality,AustrianUseCases.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | multi_currency_flag | Value to set. Value can be ta_c_b_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | multi_currency_flag is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_ngv_clearing_delay | ( | ta_object_t | trx_data, |
int | ngv_clearing_delay | ||
) |
Set defines the clearing delay of the PurchaseNGV transaction.
Available if AustrianUseCases guide is enabled.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | ngv_clearing_delay | Value to set. Value can be 0 to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ngv_clearing_delay is null-pointer. |
ta_c_rc_invalid_argument | ngv_clearing_delay is less than 0. |
ta_e_result_code_t ta_transaction_data_set_ngv_mode | ( | ta_object_t | trx_data, |
ta_e_ngv_mode_t | ngv_mode | ||
) |
Set defines if NGV usage is mandatory or optional if card supports it.
Available if AustrianUseCases guide is enabled.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | ngv_mode | Value to set. Value can be ta_c_ngvm_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | ngv_mode is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_omnichannel_merchant_id | ( | ta_object_t | trx_data, |
ta_object_t | merchant_id | ||
) |
The OmnichannelMerchantId is used to identify the merchant on a Omnichannel host. This field is not used for Saferpay, but is for example for Ogone.
Mandatory for (can not be null):
Conditional for (can be null):
Forbidden (has to be always null):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | merchant_id | Value to set. Value can be ta_c_ngvm_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | merchant_id is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_omnichannel_payment_id | ( | ta_object_t | trx_data, |
ta_object_t | payment_id | ||
) |
To identify an Omnichannel transaction (not used for Saferpay) the OmnichannelPaymentId has to be set in TransactionData. This attribute is also used to identify the Omnichannel host, a OmnichannelPaymentId starting by '90' meens for example that Ogone has to be used.
Mandatory for (can not be null):
Conditional for (can be null):
Forbidden (has to be always null):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | payment_id | Value to set. Value can be ta_c_ngvm_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | payment_id is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_partial_approval_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t | partial_approval_allowed | ||
) |
Set partial approval is allowed.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | partial_approval_allowed | Value to set. Value can be ta_c_b_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | partial_approval_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_phone_auth_code | ( | ta_object_t | trx_data, |
ta_object_t | phone_auth_code | ||
) |
Set phone authorization code.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | phone_auth_code | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | phone_auth_code is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_saferpay_alias | ( | ta_object_t | trx_data, |
ta_object_t | saferpay_alias | ||
) |
Set saferpay alias.
[in] | trx_data | Object instance of type transaction_data. |
[in] | saferpay_alias | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | saferpay_alias is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_saferpay_recurring | ( | ta_object_t | trx_data, |
ta_e_boolean_t | saferpay_recurring | ||
) |
Set saferpay recurring enabled.
[in] | trx_data | Object instance of type transaction_data. |
[in] | saferpay_recurring | Value to set. Value can be ta_c_b_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | saferpay_recurring is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_six_trx_ref_num | ( | ta_object_t | trx_data, |
ta_object_t | six_trx_ref_num | ||
) |
Set SIX Transaction Reference Number.
[in] | trx_data | Object instance of type transaction_data. |
[in] | six_trx_ref_num | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | six_trx_ref_num is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_six_trx_ref_num_mpd | ( | ta_object_t | trx_data, |
int64_t | acq_id, | ||
ta_object_t | trx_ref_num | ||
) |
SIX Transaction Reference Number for integrators using MPD Client.
[in] | trx_data | Object instance of type transaction_data. |
[in] | acq_id | AcqID as provided by MPD. |
[in] | trx_ref_num | Transaction reference as provided by MPD. Object instance has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trx_ref_num is not of type string. |
ta_e_result_code_t ta_transaction_data_set_sub_transactions | ( | ta_object_t | trx_data, |
ta_object_t | sub_transactions | ||
) |
Set sub transactions.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | sub_transactions | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type list with elements of type sub_transaction. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | sub_transactions is not ta_object_invalid and is not of type timedate. |
ta_e_result_code_t ta_transaction_data_set_tip_allowed | ( | ta_object_t | trx_data, |
ta_e_boolean_t | tip_allowed | ||
) |
Set tip is allowed for purchase transactions.
This parameter is only used if ta_c_g_gastro is enabled.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | tip_allowed | Value to set. Value can be ta_c_b_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | tip_allowed is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_token_pan | ( | ta_object_t | trx_data, |
ta_object_t | token_pan | ||
) |
Set token PAN.
The token PAN is a tokenized version for an underlaying card PAN. If the underlaying payment protocol supports it, a payment transaction can be initiated with the token PAN instead of using a card. A token PAN is normally generated by a tokenization service either form the acquirer host or the issuer host.
The TokenPan field is used in a SIXml request message as part of the sixml:TransactionData container to trigger a token-based transaction and in a SIXml response message as part of the sixml:CardData container for returning token PANs to the ECR.
The TokenPan field always must be accompanied by a corresponding TokenPanType field.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | token_pan | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | token_pan is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_token_pan_type | ( | ta_object_t | trx_data, |
ta_e_token_pan_type_t | token_pan_type | ||
) |
Set token PAN type.
To differ the source of a token PAN, the TokenPanType field is used in a SIXml request message as part of the sixml:TransactionData container and in a SIXml response message as part of the sixml:CardData container.
The TokenPanType field always is transmitted if a TokenPan field is transmitted but must not be transmitted alone.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | token_pan_type | Value to set. Value can be ta_c_tpt_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | token_pan_type is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t | trans_ref | ||
) |
Set transaction reference defined by the terminal.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | trans_ref | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trans_ref is not ta_object_invalid and is not of type integer. |
ta_e_result_code_t ta_transaction_data_set_trans_seq | ( | ta_object_t | trx_data, |
ta_object_t | trans_seq | ||
) |
Set transaction sequence number defined by the terminal.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | trans_seq | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type integer. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trans_seq is not ta_object_invalid and is not of type integer. |
ta_e_result_code_t ta_transaction_data_set_transaction_reason | ( | ta_object_t | trx_data, |
ta_e_transaction_reason_t | transaction_reason | ||
) |
Set the transaction reason to setup credential on file.
Available if AdvancedRetail guide is enabled.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | transaction_reason | Value to set. Value can be ta_c_ngvm_undefined to clear the value in trx_data. |
ta_c_rc_ok | Value assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | transaction_reason is null-pointer. |
ta_e_result_code_t ta_transaction_data_set_trm_trans_ref | ( | ta_object_t | trx_data, |
ta_object_t | trm_trans_ref | ||
) |
Set transaction reference from the terminal.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | trm_trans_ref | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type string. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trm_trans_ref is not ta_object_invalid and is not of type string. |
ta_e_result_code_t ta_transaction_data_set_trx_original_date | ( | ta_object_t | trx_data, |
ta_object_t | trx_original_date | ||
) |
Set timestamp of the original transaction.
Mandatory for (can not be ta_object_invalid):
Conditional for (can be ta_object_invalid):
Forbidden (has to be always ta_object_invalid):
Transactions will fail if one of the above mentioned restrictions are violated.
[in] | trx_data | Object instance of type transaction_data. |
[in] | trx_original_date | Object instance to set. Object instance can be ta_object_invalid to clear the value in trx_data. If object instance is not ta_object_invalid is has to be of type timedate. |
ta_c_rc_ok | Object instance assigned to trx_data. |
ta_c_rc_invalid_argument | trx_data is ta_object_invalid. |
ta_c_rc_invalid_argument | trx_data is not of type transaction_data. |
ta_c_rc_invalid_argument | trx_original_date is not ta_object_invalid and is not of type timedate. |