EFTPOS Tray Monitor & File Format

The EFTPOS Tray Monitor is used to integrate your Point Of Sale applications to work with the Payment Express Pinpads.

Requirements/Downloads:

ActiveX Control Interface XML Socket Interface Tray Monitor - File Format Specification EFTPOS Service Configuration Settings Test Scripts to use before certification Test Card Information EFTPOS Response Codes - Non Bank Codes Test account. Apply online at https://www.paymentexpress.com/pxmi/apply FAQs Merchant FAQs Developer FAQs

Installation Instructions

The Tray Monitor version of the Payment Express EFTPOS software can be found below -

Installer

http://www.paymentexpress.com/EFTPOS/PXEftInstaller_Tray.exe

Files Installed/Updated

Filename	Description
dpseftx.ocx	ActiveX Control. Will be registered with the installer.
EftTray.exe	Tray application to handle capturing of input files. Also allows access to open the Config and Maintenance control panels. Optional install.
pxpp.exe	Pinpad Controller. NT service that is installed and started with the installer.
pxeftp.exe	Communication Server. NT service that is installed and started with the installer.
pxjview.exe	Journal Viewer. Standalone Journal Viewer of past transaction history.
dpseftxc.exe	Standalone EFTPOS client for non-integrated POS transactions.
uninst.exe	Starts the uninstaller process for removing the software.

Uninstalling PX EFTPOS

• Run uninst.exe - once the program is running click Remove. You can also use Add/Remove Programs in your Control Panel.

  Using EftTray.exe

• File Message Format for File Drop
• EFTPOS Tray - Configuration
• Printing Options
• Pin Pad Simulator

EFTPOS Tray File Submission

The following is the file format to include in *.req files that you place into the directory that is monitored by the EFTPOS Tray application.

*.req Input Files

Each line of the *.req document will have an input property and is divided into sections.

The input file is used to trigger and EFTPOS payment. When it is detected, the EFTPOS software will process the file and start the payment process. The input file contains only one section. Because of this the section name is ignored, and the section marker line may be omitted completely. The following fields are defined:

[Fields] section

Parameter	Description
TxnType	The type of transaction to perform. Either the initial or the full word can be used. “P” or “Purchase”, “R” or “Refund”
TxnRef	A reference ID for the transaction. This can be used as a search term in the web reporting framework.
AmtPurchase	The total amount of the goods/services that the customer is paying for. This value should include a decimal point. If no decimal point is found, the two right-most digits will be used as the cents value.
AmtCash	The amount of cash that the customer is withdrawing as part of their payment. This value should include a decimal point. If no decimal point is found, the two right-most digits will be used as the cents value.
EnablePrintReceipt	True (1) or False (0). Default: False
EnablePrintSlip	True (1) or False (0). Default: False
EnableBacklight	True (1) or False (0). Default: False
EnableTestMode	True (1) or False (0). Default: False

Sample Data:

[Fields]
TxnType=Purchase
TxnRef=ACB12345Z
EnablePrintReceipt=1
EnablePrintSlip=0
AmtPurchase=49.95
AmtCash=20.00

*.evt Output Files

Each line of the *.evt document will have an output/settlement property and is divided into the following sections. It will also tell you how many lines you should expect in the document and are always in order.

[Fields] section

Parameter	Description
TxnRef	A reference ID for the transaction. This will be the same as the reference ID from the input file.
TxnType	The type of transaction performed. This will be the same as the transaction type from the input file.
ReCo	Two-character response code, indicating the outcome of the EFTPOS payment. Successful responses are: 00 – Accepted 08 – Accept with signature
ResponseCode	Same as ReCo. Provided for compatibility with POS software written for use with PC EFTPOS.
ResponseText	Description of the response code.
Date	Date on which the transaction was processed. The format of this number is yyyymmdd.
Time	Time at which the transaction was processed. The format of this number is hhmmss.
DateSettlement	Approximate date on which the funds should be settled. The format of this number is yyyymmdd.
CardType	The type of card used for the payment. Common values are: Visa Mastercard EFTPOS
AmtPurchase	The total amount of the goods/services that the customer is paying for.
AmtCash	The amount of cash that the customer is withdrawing as part of their payment.

[Receipt] section

Width	The number of characters on each line of the receipt.
Lines	The number of lines of receipt data present.
1 ... N	Data to be printed on the EFTPOS portion of the receipt. N is the total number of lines, as reported by Lines.

Sample Data:

[Fields]
TxnRef=ABC12345Z
TxnType=Purchase
Success=1
ReCo=00
ResponseCode=00
ResponseText=ACCEPTED
Date=20060101
Time=123456
DateSettlement=20060102
CardType=EFTPOS
AmtCash=20.00
AmtPurchase=49.95

[Receipt]
Width=30
Lines=14
1=WIDGETS R US
2=1 WIDGET WAY
3=GADGETON
4=
5=*-----------EFTPOS-----------*
6=TERMINAL 00905301  TRAN 000708
7=TIME  01JAN 12:34  ACCT CHEQUE
8=EFTPOS                  599999....0000
9=AUTHORISATION 580440 EXP 12/49
10=PURCHASE                   NZ$49.95
11=CASH                           NZ$20.00
12=TOTAL                          NZ$69.95
13=            ACCEPTED
14=*----------------------------*

EFTPOS Tray application (DpsEftTray.exe)

This should be installed in your Eftpos installation directory and is configured with the file "dpsefttray_cfg.txt", which is documented below. This tray process gives access to control panels of the ActiveX, such as Config/Setup and Maintenance and access to the DPS EFTPOS client.

The Tray process also monitors folders for *.req files if a merchant is wanting to interact with the EFTPOS system by submitting our file format.

<Monitor>

Setting	Description
InName	Name of the file types to monitor and read. Default: *.req
OutName	Name of the file type to output for the result. Default: %n.evt
Dir	Directory to monitor for the input files and to place the output files. Default: C:\Program Files\DPS\EFTPOS\FileInterface

<HotKeys>

Setting	Description
Enabled	You can enable hotkeys by setting to true (1) or set to false to disable (0). Default: 1
Action	This describes what happens when a hotkey is pressed. Values can be "Client", "Maint" &"Setup", which open up the corresponding applications or dialogs.
Key	Key to press in conjunction with the Modifier key to access the HotKey. Usually F1-F12. Default: F9
Modifier	Service Key to press in conjunction with the "Key" to access the HotKey. Values can be "Win", "Alt" or "Ctrl" and can have multiple modifiers per HotKey.

Printing Options

POS Print Queue (Controlled by Client Application)

You will need to set EnablePrintReceipt to 0 (false) if wishing to control the printing through your own application.

Windows Print Queue (Controlled by Pinpad controller)

You will need to set EnablePrintReceipt to 1 (true) if you want the Pinpad controller to Print the receipt to your default printer. You can also use the PrinterName property if you are not using the default printer or it's not using a Generic/ Text Only driver and wish to use a specific driver through the Printer Name.

Printing options can be preset in the Pinpad Configuration as well.

Pin Pad Simulator

The PIN Pad Simulator allows development and testing of Integrated EFTPOS Client Applications, e.g.: Point Of Sale (POS) without requiring connection of specialised hardware for testing. To activate the pinpad simulator, ensure the EnableTestMode property is always set to true prior to calling any method.

Properties

Set the amount to be charged or refunded (depending on the TxnType). Format is d.cc (d=dollars, c=cents). Max amount is 99999.99

Set the "Cashout" amount. Format is d.cc (d=dollars, c=cents). If no cash out is to be made, this property must be empty (blank).

Date on which the transaction was processed. The format of this number is yyyymmdd.

Indicates Date of settlement (when money will be deposited in Merchant bank account)  if this is supported by the Acquirer, otherwise contains the date the transaction was processed in YYYYMMDD format.

If set to true (1) signature receipts will be printed by the control, if other receipts are sent to your own printer queue.

Set to true if the EFTPOS subsystem should use the receipt printer to print its own receipt. Set to false if the Client application will take responsibility for printing the EFTPOS receipt. In this case, the OnPrintReceiptEvent must be handled by the client application.

The number of characters on each line of the receipt. Range 1-30.

The client application should not interpret the Response Code property contents - it is provided as informational only. The Success property determines if the the transaction was successful or not.

The Response Text is associated with ResponseCode. For successful transactions this is usually Approved and for unsuccessful transactions this can be a number of texts depending on why the transaction declined. For example it could be Card Expired, Declined, Invalid Card, REFER TO CARD ISSUER, DO NOT HONOUR. All acquirers have their own response texts and should be displayed for better understanding of why the transaction got declined.

Indicates success or failure of a method call.

Time at which the transaction was processed. The format of this number is hhmmss.

A reference ID for the transaction. This can be used as a search term in the web reporting framework.

Value	Description
Purchase	Purchase - Funds are transferred immediately.
Refund	Refund - Funds transferred immediately.