| Name | Type | Description | ||
|---|---|---|---|---|
| Id | String | The ID of the retrieved voucher type | ||
| name | String | The Name of the retrieved voucher type | ||
| alternative_code | String | The Alternative Code of the retrieved voucher type | ||
| description | String | The Description of the retrieved voucher type | ||
| classification | String | The Classification of the retrieved voucher type. The supported options are Payment Voucher, Electronic Voucher and Refund Voucher
| ||
| value_option | String | Defines if the value should be fixed or a variable. The supported options are FIXED and VARIABLE
| ||
| value | Number | The value of the retrieved voucher type. This information is available only if the value option is set to FIXED | ||
| extra_added_value | Number | The extra added value of the retrieved voucher type. This information is available only if the value option is set to FIXED
| ||
| secret_number_length | Number | The length of the secret number of the retrieved voucher type | ||
| voucher_using_method | String | The method which defines how the e-voucher can be used. This information is only available if the type's classification is "Electronic Voucher" and the supported options are PERSONAL, SHAREABLE
| ||
| minimum_allowed_value | Number | The minimum value allowed to be provided while creating an e-voucher. This information is only available if the type's value option is set to "VARIABLE" (excluding Refund Vouchers)
| ||
| maximum_allowed_value | Number | The maximum value allowed to be provided while creating an e-voucher. This information is only available if the type's value option is set to "VARIABLE" (excluding Refund Vouchers)
| ||
udf_string_1 | String | User Defined Field of type String | ||
udf_string_2 | String | User Defined Field of type String | ||
udf_string_3 | String | User Defined Field of type String | ||
udf_string_4 | String | User Defined Field of type String | ||
udf_string_5 | String | User Defined Field of type String | ||
udf_string_6 | String | User Defined Field of type String | ||
udf_string_7 | String | User Defined Field of type String | ||
udf_string_8 | String | User Defined Field of type String | ||
udf_float_1 | Float | User Defined Field of type Float | ||
udf_float_2 | Float | User Defined Field of type Float | ||
udf_float_3 | Float | User Defined Field of type Float | ||
udf_float_4 | Float | User Defined Field of type Float | ||
udf_date_1 | Date | User Defined Field of type Date | ||
udf_date_2 | Date | User Defined Field of type Date | ||
udf_date_3 | Date | User Defined Field of type Date | ||
udf_date_4 | Date | User Defined Field of type Date | ||
| Time Period Object | The validity period that a voucher of this type will be valid, measured in days or months. This information is available only if the voucher type has a "Refund Voucher" or an "Electronic Voucher" classification
| |||
| default_payment_type | Financial Transaction Type Object | The type of payment that will be created on using vouchers of this type
| ||
| default_invoice_type | Financial Transaction Type Object | The type of invoice that will be created on using vouchers of this type
| ||
| default_payment_cancellation_type | Financial Transaction Type Object | The type of Payment Cancellation that will be created on cancelling vouchers of this type upon return
| ||
| default_invoice_cancellation_type | Financial Transaction Type Object | The type of Invoice Cancellation that will be created on cancelling vouchers of this type upon return
| ||
| default_refund_method | Refund Method Object | Contains all refund methods that will be used for performing back-end reduction, except the Payment Gateways options This information is only available only if the voucher type classification is Refund Voucher
| ||
| log_information | Log Information Object | The log information of the retrieved voucher type | ||
| products_set | Set of Voucher Products Objects | The voucher type products that can consume the amount of money that will be paid by vouchers of this type |
...