Configuration Settings
The core is configured via settings inserted into the worldpay.properties file located in the chosen EFTLink folder. All available settings are listed below.
Note:
The software was previously called YesPay.
Table 12-1 WorldPay - Configuration Settings
Setting | Description | Default | Example |
---|---|---|---|
yeseft.folder |
The path to the folder where the WorldPay software is installed. Worldpay is normally installed in a folder at the root of the C: drive of the PC called YESEFT. |
\YESEFT |
|
request.port |
The socket port for making payment requests. |
10000 |
|
receipt.port |
The socket port for receiving receipts. |
20000 |
|
message.port |
The socket port for receiving status messages and dialogue requests. |
8000 |
|
perform.card.range.lookup |
If true, EFTLink will use its mapping file CardRange.xml to determine the card scheme name based on information returned by WorldPay. Otherwise, it will return the text provided by WorldPay. |
false |
|
embed.customer.receipt |
If true, EFTLink will return the customer receipt to the POS to be included in its own receipt rather than printing it separately. Note: Not all POS systems may support this feature. |
false |
|
suppress.merchant.receipt |
If true, EFTLink will discard the merchant receipt. |
false |
|
store.merchant.receipt |
If true, EFTLink will return the merchant receipt to the POS to be added to the electronic journal rather than printing it separately. This setting is overridden by suppress.merchant.receipt. Note: Not all POS systems may support this feature. |
false |
|
language |
The language code for translating responses from WorldPay on the message port. The translations are taken from WorldPay files in the WorldPay folder. The default value is "en_GB", and references part of the filename provided by WorldPay. JVTMessageBundle_en_GB.properties in \YESEFT\properties folder. |
en_GB |
|
signature.reprint.prompt |
The text to display when asking if a signature receipt should be reprinted. This message will only be shown if the operator answers no, when asked to confirm that the signature is acceptable for a previous print. |
Blank, meaning reprint will not be offered. |
|
notify.signature.print |
If true, the POS will be notified that a signature receipt has been printed. This is for the business case where the signed receipt must be stored in the cash drawer and therefore the POS needs to know to open the drawer. Note: An additional setting is required in EftlinkConfig.properties to enable this function: DeviceEvents=true |
true |
|
mid.text |
The title to display for the merchant ID in voice referrals. |
MID: |
|
tel.text |
The title to display for the telephone numbers in voice referrals. |
Tel: |
|
auth.prompt |
The text to display for the authorization code entry prompts in voice referrals. |
Enter Auth Code (or blank to cancel) |
|
max.auth.code.length |
The maximum length allowed for an entered authorization code. |
9 |
|
cashback.prompt |
The text to display for the cashback prompt. |
Cashback required? |
|
cashback.amount.prompt |
The text to display for the cashback amount prompt. |
Please enter cashback amount. |
|
min.cashback |
This is the minimum cashback amount allowed. |
Blank (no minimum amount). |
|
max.cashback |
This is the maximum cashback amount allowed. |
Blank (no maximum amount). |
|
max.cashback.length |
This is the maximum length allowed for an entered cashback amount. |
5 |
|
currency.symbol |
The currency symbol to use when displaying cashback limits to the operator. This can be any text required, for example "GBP" and so on. |
£ |
|
cnp.prompt |
This is the text to display for the customer not present prompt. |
CNP confirmation |
|
response.timeout |
The timeout in milliseconds to wait for a response from WorldPay after sending a request. It is recommended that this be left disabled (indefinite) and leave the timeout to WorldPay. |
0 (indefinite). |
|
print.x.report |
Whether to print an X report on reconciliation. |
false |
|
print.z.report |
Whether to print a Z report on reconciliation with closure. |
false |
|
x.report.title |
The title for X reports. |
** EFT X REPORT ** |
|
z.report.title |
The title for Z reports. |
** EFT Z REPORT ** |
|
address.prompt | This is the text to display for the address prompt. | Please enter first address line | address.prompt=Please enter first address line |
postcode.prompt | This is the text to display for the postcode prompt | Please enter postcode | postcode.prompt=Please enter postcode |
disable.cashback.prompt |
If true, then cashback will not be offered by the Point-of-Sale terminal. |
false |
|