CWT Software Configuration Handbook
Element Path: <cwt><PAYMENT>
The payment element controls the basic attributes for all payments in CWT. The element can be used to set up default values for VAT and purchase category as well as a mandatory value for the system tick factor and currency.
attributes
currency
| Value: | See Valid currencies for a complete list of valid currency codes in the system. |
| Default: | – |
| Description: | Defines the system currency in which all amounts are calculated. |
defaultPurchaseCategory
| Value: | See Valid Purchase Categories |
| Default: | 10 |
| Description: | Defines the default value for the purchase category for all articles that do not explicitly have a purchase category defined. |
defaultVAT
| Value: | 0–4294967295 |
| Default: | 0 |
| Description: | Defines the default VAT value for all articles that do not explicitly have a VAT value defined. This can be a convenient way to configure a system with many articles with the same VAT. The value is specified as an integer including two decimals. A value of 2500 means 25 %. |
defaultVATCategory
| Value: | 0–4294967295 |
| Default: | 1 |
| Description: | Defines the default VAT category (Only used for credit card in the Nordic markets) |
0=No VAT
1=Standard VAT
2=Medium VAT
3=Low VAT
maxTicks
| Value: | 32767 - 200000 |
| Default: | 32767 |
| Description: | Defines the maximum allowed value for max ticks in a tariff. |
| Example: | For a currency where the tick factor is 1, e.g. LBP (Lebanon), the max ticks in a tariff can exceed the default maximum allowed value which causes a purchase to fail. |
ongoingPurchaseDatabaseLocation
| Value: | StandAlone, Global |
| Default: | StandAlone |
| Description: | Location where the Ongoing Purchase data shall be stored or sent. If set to Global the purchase will be sent to WebOffice. |
Note:
This attribute is also available in <cwt><PAYMENTSERVICE>. Setting the attribute in <cwt><PAYMENT> will act as default and any value set in <cwt><PAYMENTSERVICE> will override this setting when that payment service is selected
See Ongoing Purchases for a complete description
ongoingPurchaseDatabaseReplication
| Value: | None, |
AtPurchase,
RequiredForPurchase,
RequiredForPurchaseFallback,
AtPurchaseSmsFallback,
RequiredForPurchaseFallbackAndSmsFallback,
AtPurchaseSmsAsPrimaryDelivery,
RequiredForPurchaseAfterCardValidation,
RequiredForPurchaseAfterCardValidationFallback,
RequiredForPurchaseAfterCardValidationFallbackAndSmsFallback
| Default: | None |
| Description: | Defines when the ongoing purchase information shall be sent to the location defined by the attribute ongoingPurchaseDatabaseLocation. If “None” is selected the ongoing purchase information will not be sent at all. |
See Ongoing Purchases for a complete description
Note: This attribute is also available in <PAYMENTSERVICE>. Setting the attribute in <PAYMENT> will act as default and any value set in <PAYMENTSERVICE> will override this setting when that payment service is selected
If None is selected the ongoing purchase information will not be sent at all.
If AtPurchase is selected the ongoing purchase information will be sent after the purchase.
If RequiredForPurchase is selected the ongoing purchase information is sent synchronously during the purchase.
If RequiredForPurchaseFallback is selected the ongoing purchase information is sent synchronously during the purchase. And if there is no response from third party the ongoing purchase information will be sent after the purchase
If AtPurchaseSmsFallback is selected the ongoing purchase information will be sent after the purchase.
If the normal data communication for WebOffice fails. A reduced set of ongoing purchase data will be sent in a SMS.
If RequiredForPurchaseFallback is selected the ongoing purchase information is sent synchronously during the purchase. And if there is no response from third party the ongoing purchase information will be sent after the purchase. If the normal data communication for WebOffice fails. A reduced set of ongoing purchase data will be sent in a SMS.
If AtPurchaseSmsAsPrimaryDelivery is selected a reduced set of ongoing purchase data will be sent after the purchase in a SMS as the primary online synchronization. The complete ongoing purchase information will be sent in a regular heartbeat.
If RequiredForPurchaseAfterCardValidation is selected the ongoing purchase information is sent synchronously during the purchase, after card validation is done. (in cAcceptPhase_8_ValidateCardOnAccept)
If RequiredForPurchaseAfterCardValidationFallback is selected the ongoing purchase information is sent synchronously during the purchase, after card validation is done. And if there is no response from third party the ongoing purchase information will be sent after the purchase.
If RequiredForPurchaseAfterCardValidationFallbackAndSmsFallback is selected the ongoing purchase information is sent synchronously during the purchase, after card validation is done. And if there is no response from third party the ongoing purchase information will be sent after the purchase.
| Example: | This Example: shows the <PAYMENT> element defining the defaults for the Ongoing Purchases. |
•The first <PAYMENTSERVICE> element uses the default values set by the <PAYMENT> element
•The second, third, and forth <PAYMENTSERVICE> element re-defines the OngoingPurchaseDatabaseReplication attribute
<PAYMENT ongoingPurchaseDatabaseLocation="Global" ongoingPurchaseDatabaseReplication="None"/>
<PAYMENTSERVICE paymentServiceId="0" name="PS1">
<payUnit name="Coin"/>
</PAYMENTSERVICE>
<PAYMENTSERVICE paymentServiceId="1" name="PS2" ongoingPurchaseDatabaseReplication="RequiredForPurchase">
<payUnit name="Coin"/>
</PAYMENTSERVICE>
<PAYMENTSERVICE paymentServiceId="2" name="PS3" ongoingPurchaseDatabaseReplication="RequiredForPurchaseFallback">
<payUnit name="Coin"/>
</PAYMENTSERVICE>
<PAYMENTSERVICE paymentServiceId="3" name="PS4" ongoingPurchaseDatabaseReplication="AtPurchase">
<payUnit name="Coin"/>
</PAYMENTSERVICE>
personalAccountLocation
| Value: | Online, Offline |
| Default: | Offline |
| Description: | The attribute defines where the server of Personal Account is located. If set to Online, then the CWT requests Personal Account information from WebOffice. See also personalAccount. |
purchaseFrequencyGuard
testPurchasesTariffPackageId
| Value: | 0 – 2147483647 |
| Default: | 0 |
| Description: | To be able to perform a test purchase the testPurchasesTariffPackageId MUST be defined to a valid tariff package id in the PAYMENT element. |
tickFactor
| Value: | 0–4294967295 |
| Default: | 1 |
| Description: | Defines how many ticks the national currency unit (e.g. Dollar, Krona, Yen etc.) should give in the system. A typical set-up is to have a tick factor that results in 1 tick for the coin with the lowest value. The pay unit channel mapping must match this set-up. See PAYUNIT Channel. |
| Example: | If tick factor is 100 and currency is US dollar this means that a 1 dollar-cent coin is worth 1 tick while a 1 dollar coin is worth 100 ticks. The PAYUNIT channel set-up for the 1 dollar coin should then be value 100. |
Example:
A tick factor of 100 and currency is EURO (978) with a default VAT percentage of 25% for the terminal. The purchase category is 10 (parking tickets) and the tariff package used for test purchases is the one that has tariff package id “1”:
<PAYMENT tickFactor="100" currency="978"
defaultPurchaseCategory="10" defaultVAT="2500"
personalAccountLocation="Offline"
testPurchasesTariffPackageId="1" />
