Linkly
On this page
Linkly is an Australia-based integrated EFTPOS payment solution for StoreConnect POS, enabling card payments and refunds directly through Linkly-connected terminals. Linkly is a POS-only payment method — it does not support online checkout.
Supported features
- POS card payments (integrated EFTPOS)
- POS refunds
- Surcharge support
- Crash recovery for incomplete transactions
What you need
- A Linkly Cloud account with API credentials (one set per register)
- Linkly-compatible EFTPOS terminal(s) connected to Linkly Cloud. Some major banks (including NAB, Westpac) can provide hardware that integrates with Linkly.
- Outlets configured in StoreConnect
:::note Each register requires its own Linkly Cloud API credentials (API key and API secret). Contact your Linkly account manager to obtain credentials for each register you intend to use. :::
Configure Linkly in StoreConnect
Add the payment provider
- In StoreConnect, go to Settings > Payments > Payment providers.
- Select New. Complete the fields as follows, then Save.
| StoreConnect field | Value |
|---|---|
| Name | Linkly |
| Provider | Linkly |
| API Mode | sandbox / production |
Add API credentials
Each register uses its own API credential pair, drawn from a pool you define on the payment provider record. You must add one credential pair to the pool for every register that will use Linkly.
Add the following to the API Options field, with one entry per register:
yaml
unclaimed_api_creds:
- api_key: "YOUR_API_KEY"
api_secret: "YOUR_API_SECRET"
For multiple registers, add one entry per register:
yaml
unclaimed_api_creds:
- api_key: "REGISTER_1_API_KEY"
api_secret: "REGISTER_1_API_SECRET"
- api_key: "REGISTER_2_API_KEY"
api_secret: "REGISTER_2_API_SECRET"
When a register pairs its terminal, a credential is automatically claimed from this pool and assigned to that register. If pairing fails, the credential is returned to the pool.
Configure outlets
To enable Linkly at specific outlets, add the outlet SFIDs to the API Options field:
yaml
pos_outlets:
"YOUR_OUTLET_SFID": true
To find an outlet SFID, open the outlet record in StoreConnect. The SFID appears in the browser URL, for example: a24ao000001lE6zAAE.
Enable Linkly as a store variable
- In StoreConnect, go to your store and open the Store Variables section.
- Select New.
- Enter the following values, then Save.
| Field | Value |
|---|---|
| Name | POS: Linkly payments |
| Key | pos.payment_options.card_linkly_integrated.enabled |
| Value | true |
Pair your terminal
Each register must pair with a Linkly EFTPOS terminal before taking payments. Pairing assigns a unique credential from the pool to the register.
- On your EFTPOS terminal, generate a 6-digit pair code. The exact steps vary by terminal model — refer to your terminal documentation or contact Linkly support. On many terminals, you can access this via Func > 7410 > Terminal Setup > Cloud Comms.
- In the POS, go to Settings > Linkly.
- Enter the 6-digit pair code.
- Select Pair terminal.
- When the status shows Paired & Connected, the terminal is ready to use.
:::note The pair code expires after a short time. If pairing fails, generate a new code on the terminal and try again. :::
Terminal connection states
| Status | Meaning |
|---|---|
| Paired & Connected | Terminal is paired and the session token is active |
| Disconnected | Terminal is paired but the session token has expired — select Reconnect |
| Pairing in progress | Pairing request sent, waiting for terminal confirmation |
| No setup | Terminal has not been paired on this register |
To disconnect a terminal from a register, select Unpair in POS Settings. The register’s credential is returned to the unclaimed pool and can be used by another register.
Take a payment
- Add items to the cart and proceed to checkout.
- Select Linkly as the payment method.
- Confirm the payment amount.
- Select Take payment.
- The EFTPOS terminal prompts the customer to tap, insert, or swipe their card.
- The POS polls the terminal automatically until the transaction completes.
- On success, the payment is recorded and the order is finalised.
You can select Cancel transaction at any point while waiting for the terminal.
Process a refund
- Open the original order and initiate a return.
- Select Refund and choose Linkly as the payment method.
- Confirm the refund amount.
- The terminal prompts the customer to present their card.
- On success, the refund is recorded against the original order.
Crash recovery
If the POS closes or crashes during a Linkly transaction, a recovery prompt appears the next time the POS is opened on that register. The recovery process automatically checks the transaction status with Linkly Cloud:
- If the transaction completed on the terminal, the payment is recorded and the order is finalised.
- If the transaction did not complete, it is cleared and no payment is recorded.
This prevents duplicate charges and ensures the order record remains accurate.
Surcharge
To apply a surcharge for Linkly card payments, configure a surcharge product on the payment provider record. See Passing payment surcharges to customers for details.