transaction_request.h File Reference

Description

Transaction request.

Object type transaction_request.

Functions
ta_e_result_code_t	ta_transaction_request_create (ta_object_t *request)
	Create object of type transaction_request. More...
ta_e_result_code_t	ta_transaction_request_copy (ta_object_t *request, const ta_object_t *source_request)
	Create deep copy of object instance of type transaction_request. More...
ta_e_result_code_t	ta_transaction_request_get_user_id (ta_object_t request, ta_object_t *user_id)
	ECR user identifier. More...
ta_e_result_code_t	ta_transaction_request_set_user_id (ta_object_t request, ta_object_t user_id)
	Set ECR user identifier. More...
ta_e_result_code_t	ta_transaction_request_get_amount (ta_object_t request, ta_object_t *amount)
	Transaction amount and currency. More...
ta_e_result_code_t	ta_transaction_request_set_amount (ta_object_t request, ta_object_t amount)
	Set transaction amount and currency. More...
ta_e_result_code_t	ta_transaction_request_get_transaction_data (ta_object_t request, ta_object_t *transaction_data)
	Transaction information. More...
ta_e_result_code_t	ta_transaction_request_set_transaction_data (ta_object_t request, ta_object_t transaction_data)
	Set transaction information. More...
ta_e_result_code_t	ta_transaction_request_get_merchant_options (ta_object_t request, ta_object_t *merchant_options)
	Additional merchant options. More...
ta_e_result_code_t	ta_transaction_request_set_merchant_options (ta_object_t request, ta_object_t merchant_options)
	Set additional merchant options. More...
ta_e_result_code_t	ta_transaction_request_get_additional_info (ta_object_t request, ta_object_t *additional_info)
	Additional information list. More...
ta_e_result_code_t	ta_transaction_request_set_additional_info (ta_object_t request, ta_object_t additional_info)
	Set additional information list. More...
ta_e_result_code_t	ta_transaction_request_get_basket (ta_object_t request, ta_object_t *basket)
	Petrol: Basket. More...
ta_e_result_code_t	ta_transaction_request_set_basket (ta_object_t request, ta_object_t basket)
	Set request (petrol). More...
ta_e_result_code_t	ta_transaction_request_get_amount_tip (ta_object_t request, ta_object_t *amount_tip)
	Proposed tip amount. More...
ta_e_result_code_t	ta_transaction_request_set_amount_tip (ta_object_t request, ta_object_t amount_tip)
	Set proposed tip amount. More...
ta_e_result_code_t	ta_transaction_request_get_amount_other (ta_object_t request, ta_object_t *amount_other)
	Cashback amount and currency. More...
ta_e_result_code_t	ta_transaction_request_set_amount_other (ta_object_t request, ta_object_t amount_other)
	Set cashback amount and currency. More...
ta_e_result_code_t	ta_transaction_request_get_amount_discount (ta_object_t request, ta_object_t *amount_discount)
	Discount amount and currency. More...
ta_e_result_code_t	ta_transaction_request_set_amount_discount (ta_object_t request, ta_object_t amount_discount)
	Set discount amount and currency. More...
ta_e_result_code_t	ta_transaction_request_get_loyalty_coupon_list (ta_object_t request, ta_object_t *loyalty_coupon_list)
	Loyalty coupon list. More...
ta_e_result_code_t	ta_transaction_request_set_loyalty_coupon_list (ta_object_t request, ta_object_t loyalty_coupon_list)
	Set loyalty coupon list. More...
ta_e_result_code_t	ta_transaction_request_get_retain_card (ta_object_t request, ta_e_boolean_t *retain_card)
	Retain card. More...
ta_e_result_code_t	ta_transaction_request_set_retain_card (ta_object_t request, ta_e_boolean_t retain_card)
	Set retain card. More...

Function Documentation

ta_transaction_request_copy()

ta_e_result_code_t ta_transaction_request_copy	(	ta_object_t *	request,
		const ta_object_t *	source_request
	)

Create deep copy of object instance of type transaction_request.

Parameters

[out]	request	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	source_request	Object of type transaction_request to create copy of.

Return values

ta_c_rc_ok	Object instance has been created and written to request.
ta_c_rc_invalid_argument	request is null-pointer.
ta_c_rc_invalid_argument	source_request is ta_invalid_object.
ta_c_rc_invalid_argument	source_request is not of type transaction_request.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_transaction_request_create()

ta_e_result_code_t ta_transaction_request_create

(

ta_object_t *

request

)

Create object of type transaction_request.

Parameters

[out]

request

Pointer to variable to write created object instance to. Created object instance is retained.

Return values

ta_c_rc_ok	Object instance has been created and written to request.
ta_c_rc_invalid_argument	request is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_transaction_request_get_additional_info()

ta_e_result_code_t ta_transaction_request_get_additional_info	(	ta_object_t	request,
		ta_object_t *	additional_info
	)

Additional information list.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	additional_info	Pointer to variable to write object instance to. Object instance is of type map and is not retained. The map contains keys of type integer and values of type string.

Return values

ta_c_rc_ok	Object instance written to additional_info.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	additional_info is null-pointer.

ta_transaction_request_get_amount()

ta_e_result_code_t ta_transaction_request_get_amount	(	ta_object_t	request,
		ta_object_t *	amount
	)

Transaction amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	amount	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to amount.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount is null-pointer.

ta_transaction_request_get_amount_discount()

ta_e_result_code_t ta_transaction_request_get_amount_discount	(	ta_object_t	request,
		ta_object_t *	amount_discount
	)

Discount amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	amount_discount	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to amount_discount.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_discount is null-pointer.

ta_transaction_request_get_amount_other()

ta_e_result_code_t ta_transaction_request_get_amount_other	(	ta_object_t	request,
		ta_object_t *	amount_other
	)

Cashback amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	amount_other	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to amount_other.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_other is null-pointer.

ta_transaction_request_get_amount_tip()

ta_e_result_code_t ta_transaction_request_get_amount_tip	(	ta_object_t	request,
		ta_object_t *	amount_tip
	)

Proposed tip amount.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	amount_tip	Pointer to variable to write object instance to. Object instance is of type amount and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to amount_tip.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_tip is null-pointer.

ta_transaction_request_get_basket()

ta_e_result_code_t ta_transaction_request_get_basket	(	ta_object_t	request,
		ta_object_t *	basket
	)

Petrol: Basket.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	basket	Pointer to variable to write object instance to. Object instance is of type basket and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to basket.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	basket is null-pointer.

ta_transaction_request_get_loyalty_coupon_list()

ta_e_result_code_t ta_transaction_request_get_loyalty_coupon_list	(	ta_object_t	request,
		ta_object_t *	loyalty_coupon_list
	)

Loyalty coupon list.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	loyalty_coupon_list	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type loyalty_coupon.

Return values

ta_c_rc_ok	Object instance written to loyalty_coupon_list.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	loyalty_coupon_list is null-pointer.

ta_transaction_request_get_merchant_options()

ta_e_result_code_t ta_transaction_request_get_merchant_options	(	ta_object_t	request,
		ta_object_t *	merchant_options
	)

Additional merchant options.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	merchant_options	Pointer to variable to write object instance to. Object instance is of type list and is not retained. The list contains elements of type merchant_option.

Return values

ta_c_rc_ok	Object instance written to merchant_options.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	merchant_options is null-pointer.

ta_transaction_request_get_retain_card()

ta_e_result_code_t ta_transaction_request_get_retain_card	(	ta_object_t	request,
		ta_e_boolean_t *	retain_card
	)

Retain card.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	retain_card	Pointer to variable to write object instance to.

Return values

ta_c_rc_ok	Object instance written to retain_card.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	retain_card is null-pointer.

ta_transaction_request_get_transaction_data()

ta_e_result_code_t ta_transaction_request_get_transaction_data	(	ta_object_t	request,
		ta_object_t *	transaction_data
	)

Transaction information.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	transaction_data	Pointer to variable to write object instance to. Object instance is of type transaction_data and is not retained. Object instance is ta_invalid_object if value is not set in request.

Return values

ta_c_rc_ok	Object instance written to transaction_data.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	transaction_data is null-pointer.

ta_transaction_request_get_user_id()

ta_e_result_code_t ta_transaction_request_get_user_id	(	ta_object_t	request,
		ta_object_t *	user_id
	)

ECR user identifier.

Parameters

[in]	request	Object instance of type transaction_request.
[out]	user_id	Pointer 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 request.

Return values

ta_c_rc_ok	Object instance written to user_id.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	user_id is null-pointer.

ta_transaction_request_set_additional_info()

ta_e_result_code_t ta_transaction_request_set_additional_info	(	ta_object_t	request,
		ta_object_t	additional_info
	)

Set additional information list.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	additional_info	Object instance to set. Object instance has to be of type map. The map has to contain keys of type integer and values of type string.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	additional_info is ta_invalid_object.
ta_c_rc_invalid_argument	additional_info is not of type map.
ta_c_rc_invalid_argument	Key in additional_info is ta_invalid_object.
ta_c_rc_invalid_argument	Key in additional_info is not of type integer.
ta_c_rc_invalid_argument	Value in additional_info is ta_invalid_object.
ta_c_rc_invalid_argument	Value in additional_info is not of type string.

ta_transaction_request_set_amount()

ta_e_result_code_t ta_transaction_request_set_amount	(	ta_object_t	request,
		ta_object_t	amount
	)

Set transaction amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	amount	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount is not ta_invalid_object and is not of type amount.

ta_transaction_request_set_amount_discount()

ta_e_result_code_t ta_transaction_request_set_amount_discount	(	ta_object_t	request,
		ta_object_t	amount_discount
	)

Set discount amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	amount_discount	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type amount_discount.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_discount is not ta_invalid_object and is not of type amount_discount.

ta_transaction_request_set_amount_other()

ta_e_result_code_t ta_transaction_request_set_amount_other	(	ta_object_t	request,
		ta_object_t	amount_other
	)

Set cashback amount and currency.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	amount_other	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_other is not ta_invalid_object and is not of type amount.

ta_transaction_request_set_amount_tip()

ta_e_result_code_t ta_transaction_request_set_amount_tip	(	ta_object_t	request,
		ta_object_t	amount_tip
	)

Set proposed tip amount.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	amount_tip	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type amount.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	amount_tip is not ta_invalid_object and is not of type amount.

ta_transaction_request_set_basket()

ta_e_result_code_t ta_transaction_request_set_basket	(	ta_object_t	request,
		ta_object_t	basket
	)

Set request (petrol).

Parameters

[in]	request	Object instance of type transaction_request.
[in]	basket	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type basket.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	basket is not ta_invalid_object and is not of type basket.

ta_transaction_request_set_loyalty_coupon_list()

ta_e_result_code_t ta_transaction_request_set_loyalty_coupon_list	(	ta_object_t	request,
		ta_object_t	loyalty_coupon_list
	)

Set loyalty coupon list.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	loyalty_coupon_list	Object instance to set. Object instance has to be of type list. The list has to contain elements of type loyalty_coupon.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	loyalty_coupon_list is ta_invalid_object.
ta_c_rc_invalid_argument	loyalty_coupon_list is not of type list.
ta_c_rc_invalid_argument	Element in loyalty_coupon_list is ta_invalid_object.
ta_c_rc_invalid_argument	Element in loyalty_coupon_list is not of type loyalty_coupon.

ta_transaction_request_set_merchant_options()

ta_e_result_code_t ta_transaction_request_set_merchant_options	(	ta_object_t	request,
		ta_object_t	merchant_options
	)

Set additional merchant options.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	merchant_options	Object instance to set. Object instance has to be of type list. The list has to contain elements of type merchant_option.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	merchant_options is ta_invalid_object.
ta_c_rc_invalid_argument	merchant_options is not of type list.
ta_c_rc_invalid_argument	Element in merchant_options is ta_invalid_object.
ta_c_rc_invalid_argument	Element in merchant_options is not of type merchant_option.

ta_transaction_request_set_retain_card()

ta_e_result_code_t ta_transaction_request_set_retain_card	(	ta_object_t	request,
		ta_e_boolean_t	retain_card
	)

Set retain card.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	retain_card	Value to set.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.

ta_transaction_request_set_transaction_data()

ta_e_result_code_t ta_transaction_request_set_transaction_data	(	ta_object_t	request,
		ta_object_t	transaction_data
	)

Set transaction information.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	transaction_data	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type transaction_data.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	transaction_data is not ta_invalid_object and is not of type transaction_data.

ta_transaction_request_set_user_id()

ta_e_result_code_t ta_transaction_request_set_user_id	(	ta_object_t	request,
		ta_object_t	user_id
	)

Set ECR user identifier.

Parameters

[in]	request	Object instance of type transaction_request.
[in]	user_id	Object instance to set. Object instance can be ta_invalid_object to clear the value in request. If object instance is not ta_invalid_object is has to be of type integer.

Return values

ta_c_rc_ok	Object instance assigned to request.
ta_c_rc_invalid_argument	request is ta_invalid_object.
ta_c_rc_invalid_argument	request is not of type transaction_request.
ta_c_rc_invalid_argument	user_id is not ta_invalid_object and is not of type integer.