The PayX CloudLink EFTPOS integration allows IBIS to process EFTPOS transactions via the PayX CloudLink cloud service, which communicates with supported Android EFTPOS terminals.
This is a cloud-based integration, not a direct USB or serial connection. IBIS sends transaction requests to PayX via a REST API, and PayX handles all communication with the EFTPOS terminal.
This integration supports Worldline / Paymark processing and links to major New Zealand banks including BNZ, ASB, ANZ, and Westpac.
TABLE OF CONTENTS
- Supported EFTPOS terminals
- How the integration works
- Hardware & system requirements
- Required settings
- Cash out behaviour
- EFTPOS receipts
- Using EFTPOS in IBIS (PayX CloudLink)
- Processing an EFTPOS sale
- Processing a refund
- Declined transactions
- Transaction timeouts or cancellation
- Connection loss and recovery
- Important PayX CloudLink notes
Supported EFTPOS terminals
PAX A920 Pro
PAX A910s
PAX A35
Hardware, terminal setup, and PayX provisioning are supplied by Sektor.
How the integration works
IBIS sends a payment request to the PayX API
PayX CloudLink routes the request to the EFTPOS terminal
The customer completes the transaction on the terminal
PayX returns the transaction result to IBIS
IBIS completes or fails the sale accordingly
Because this is cloud-based:
No USB connection is required
Both IBIS and the EFTPOS terminal must have internet access
Hardware & system requirements
Supported PAX Android terminal with PayX CloudLink installed
Windows 10 or later on IBIS workstations
Stable internet connection for both IBIS and the terminal
Thermal receipt printer (for EFTPOS receipt printing via IBIS, if enabled)
Required settings
The following settings only need to be set once per system in the System > System settings > Point of sale section.
| Setting | Description |
|---|---|
| PayX – API Key | API key provided by PayX |
| PayX – Base URL | PayX API endpoint (same for dev, UAT, and live) |
Additional PayX EFTPOS-specific settings must be configured on each device in the System > Machine settings screen.
| Setting | Value / Description |
|---|---|
| Eftpos provider | PayXCloudLink |
| Eftpos Terminal IP Address | Not required (cloud-based integration) |
| Eftpos Terminal Station ID | Terminal serial number (printed on device) |
| PayX – Merchant ID | Provided by PayX |
| PayX – Payment Media Code | PJS |
| PayX – Polling Interval (ms) | 500 |
| PayX – Max Wait (seconds) | 30 |
| PayX – Print on Terminal | False (recommended) |
Some of these settings may be shared with other integrations (e.g. Windcave HIT). Do not change values unless instructed.
Cash out behaviour
PayX does not support cash out within a transaction.
The IBIS system setting:
Cash out on EFTPOS
must be set to False
If customers require cash out, it must be processed as a separate non-stock transaction in IBIS.
EFTPOS receipts
EFTPOS receipts can be printed via IBIS on the standard receipt printer
Receipt formatting is text-only, as PayX returns HTML-based receipts
Layout may vary slightly depending on transaction type
Printing EFTPOS receipts directly on the terminal is supported, but not recommended for standard operation.
Using EFTPOS in IBIS (PayX CloudLink)
The process for using PayX CloudLink is almost identical to other integrated EFTPOS providers in IBIS.
If you have previously used integrated EFTPOS, your payment types should already be configured.
If not, ensure an EFTPOS payment type is set up and visible on the POS screen.
Processing an EFTPOS sale
Add the required items to the sale in Point of Sale
Click the EFTPOS payment button
The POS screen will turn grey and the EFTPOS payment window will appear
While the POS screen is greyed out, all other actions are locked to prevent accidental interaction.
The payment pop-up will indicate PayX CloudLink at the top.
The Amount field auto-populates with the sale total
Can be edited for partial payments
Cash out is not available
Click Process to continue
Follow the prompts on the EFTPOS terminal
Once approved:
You are returned to POS
The payment appears in the Payments section
An EFTPOS transaction reference is recorded
A receipt prints (if IBIS receipt printing is enabled)
Processing a refund
Ensure the correct item(s) are displayed with a negative value
Click the EFTPOS payment button
The EFTPOS window opens in refund mode
The amount displays as a negative value
Click Process
Follow the terminal prompts
Once completed:
You return to POS
The balance shows $0.00
An EFTPOS transaction reference is recorded
A refund receipt prints (if configured)
Declined transactions
If a transaction is declined:
A declined message is displayed
You are returned to POS
The sale remains unpaid and can be amended or retried
A declined receipt may print depending on terminal configuration
Transaction timeouts or cancellation
If a transaction needs to be cancelled after being sent to the terminal:
Click Cancel while waiting for the card
If the transaction times out, IBIS returns to POS automatically
No payment is applied to the sale
Connection loss and recovery
If there is a temporary internet or application interruption during a transaction:
IBIS automatically attempts to determine the transaction outcome
On reopening POS, IBIS may prompt to recover the EFTPOS transaction
The transaction resolves as either successful or failed
Manual intervention is not required
Important PayX CloudLink notes
Cash out is not supported
EFTPOS communication is cloud-based
Receipt formatting may vary compared to other providers
Printing receipts directly on the EFTPOS terminal is not recommended