mobile_topup_value.h File Reference

Description

Contains the name of a mobile topup issuer and an associated voucher value.

Object type mobile_topup_value.

Functions
ta_e_result_code_t	ta_mobile_topup_value_create (ta_object_t *value)
	Create object of type mobile_topup_value. More...
ta_e_result_code_t	ta_mobile_topup_value_copy (ta_object_t *value, const ta_object_t *source_value)
	Create deep copy of object instance of type mobile_topup_value. More...
ta_e_result_code_t	ta_mobile_topup_value_get_issuer_name (ta_object_t value, ta_object_t *issuer_name)
	Contains the name of an issuer off (mobile topup) vouchers. More...
ta_e_result_code_t	ta_mobile_topup_value_set_issuer_name (ta_object_t value, ta_object_t issuer_name)
	Contains the name of an issuer off (mobile topup) vouchers. More...
ta_e_result_code_t	ta_mobile_topup_value_get_card_ref (ta_object_t value, ta_object_t *card_ref)
	Reference number provided and created for the card. More...
ta_e_result_code_t	ta_mobile_topup_value_set_card_ref (ta_object_t value, ta_object_t card_ref)
	Reference number provided and created for the card. More...
ta_e_result_code_t	ta_mobile_topup_value_get_app_expiration_date (ta_object_t value, ta_object_t *app_expiration_date)
	Application expiration date. More...
ta_e_result_code_t	ta_mobile_topup_value_set_app_expiration_date (ta_object_t value, ta_object_t app_expiration_date)
	Application expiration date. More...
ta_e_result_code_t	ta_mobile_topup_value_get_amount (ta_object_t value, ta_object_t *amount)
	In a request defines the original amount for the transaction (given by ECR). More...
ta_e_result_code_t	ta_mobile_topup_value_set_amount (ta_object_t value, ta_object_t amount)
	In a request defines the original amount for the transaction (given by ECR). More...

Function Documentation

ta_mobile_topup_value_copy()

ta_e_result_code_t ta_mobile_topup_value_copy	(	ta_object_t *	value,
		const ta_object_t *	source_value
	)

Create deep copy of object instance of type mobile_topup_value.

Parameters

[out]	value	Pointer to variable to write created object instance to. Created object instance is retained.
[in]	source_value	Object of type mobile_topup_value to create copy of.

Return values

ta_c_rc_ok	Object instance has been created and written to value.
ta_c_rc_invalid_argument	value is null-pointer.
ta_c_rc_invalid_argument	source_item is ta_object_invalid.
ta_c_rc_invalid_argument	source_item is not of type mobile_topup_value.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_mobile_topup_value_create()

ta_e_result_code_t ta_mobile_topup_value_create

(

ta_object_t *

value

)

Create object of type mobile_topup_value.

Parameters

[out]

value

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 value.
ta_c_rc_invalid_argument	value is null-pointer.
ta_c_rc_out_of_memory	Failed allocating memory.

ta_mobile_topup_value_get_amount()

ta_e_result_code_t ta_mobile_topup_value_get_amount	(	ta_object_t	value,
		ta_object_t *	amount
	)

In a request defines the original amount for the transaction (given by ECR).

In response the final authorized amount (given by host) in minor units.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[out]	amount	Pointer to variable to write object instance to. Object instance is of type list with entries of type amount and is not retained. Object instance is ta_object_invalid if value is not set in value.

Return values

ta_c_rc_ok	Object instance written to amount.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	amount is not null-pointer.

ta_mobile_topup_value_get_app_expiration_date()

ta_e_result_code_t ta_mobile_topup_value_get_app_expiration_date	(	ta_object_t	value,
		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. Optional: For PAN based Mobile Topup transactions. Needs to be present if CardRef is present.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[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 value.

Return values

ta_c_rc_ok	Object instance written to app_expiration_date.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	app_expiration_date is not null-pointer.

ta_mobile_topup_value_get_card_ref()

ta_e_result_code_t ta_mobile_topup_value_get_card_ref	(	ta_object_t	value,
		ta_object_t *	card_ref
	)

Reference number provided and created for the card.

Optional: For PAN based Mobile Topup transactions. Send type 06 Non-PCI-PAN.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[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 value.

Return values

ta_c_rc_ok	Object instance written to card_ref.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	card_ref is not null-pointer.

ta_mobile_topup_value_get_issuer_name()

ta_e_result_code_t ta_mobile_topup_value_get_issuer_name	(	ta_object_t	value,
		ta_object_t *	issuer_name
	)

Contains the name of an issuer off (mobile topup) vouchers.

Optional: For brand name based Mobile Topup transactions.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[out]	issuer_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 mobile_topup_value.

Return values

ta_c_rc_ok	Object instance written to issuer_name.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	issuer_name is not null-pointer.

ta_mobile_topup_value_set_amount()

ta_e_result_code_t ta_mobile_topup_value_set_amount	(	ta_object_t	value,
		ta_object_t	amount
	)

In a request defines the original amount for the transaction (given by ECR).

In response the final authorized amount (given by host) in minor units.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[in]	amount	Object instance to set. Object instance can be ta_object_invalid to clear the value in value. If object instance is not ta_object_invalid is has to be of type list with entries of type amount.

Return values

ta_c_rc_ok	Object instance assigned to value.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	amount is not ta_object_invalid and is not of type amount.

ta_mobile_topup_value_set_app_expiration_date()

ta_e_result_code_t ta_mobile_topup_value_set_app_expiration_date	(	ta_object_t	value,
		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. Optional: For PAN based Mobile Topup transactions. Needs to be present if CardRef is present.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[in]	app_expiration_date	Object instance to set. Object instance can be ta_object_invalid to clear the value in value. If object instance is not ta_object_invalid is has to be of type timedate.

Return values

ta_c_rc_ok	Object instance assigned to value.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	app_expiration_date is not ta_object_invalid and is not of type timedate.

ta_mobile_topup_value_set_card_ref()

ta_e_result_code_t ta_mobile_topup_value_set_card_ref	(	ta_object_t	value,
		ta_object_t	card_ref
	)

Reference number provided and created for the card.

Optional: For PAN based Mobile Topup transactions. Send type 06 Non-PCI-PAN.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[in]	card_ref	Object instance to set. Object instance can be ta_object_invalid to clear the value in value. If object instance is not ta_object_invalid is has to be of type string.

Return values

ta_c_rc_ok	Object instance assigned to value.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	card_ref is not ta_object_invalid and is not of type string.

ta_mobile_topup_value_set_issuer_name()

ta_e_result_code_t ta_mobile_topup_value_set_issuer_name	(	ta_object_t	value,
		ta_object_t	issuer_name
	)

Contains the name of an issuer off (mobile topup) vouchers.

Optional: For brand name based Mobile Topup transactions.

Parameters

[in]	value	Object instance of type mobile_topup_value.
[in]	issuer_name	Object instance to set. Object instance can be ta_object_invalid to clear the value in value. If object instance is not ta_object_invalid is has to be of type integer.

Return values

ta_c_rc_ok	Object instance assigned to value.
ta_c_rc_invalid_argument	value is ta_object_invalid.
ta_c_rc_invalid_argument	value is not of type mobile_topup_value.
ta_c_rc_invalid_argument	issuer_name is not ta_object_invalid and is not of type integer.