Linkly
On this page
Linkly is an integrated EFTPOS payment solution for StoreConnect POS, enabling card payments and refunds directly through Linkly-connected terminals. Linkly is a POS-only payment method and does not support online checkout.
Where Linkly can be used
Linkly is an Australian company, but the technology can be enabled beyond Australia. StoreConnect does not restrict Linkly to any country. Check with Linkly whether the service is available in your location.
Supported features
- POS card payments (integrated EFTPOS)
- POS refunds
- Surcharge support
- Recovery of interrupted payments, without charging the customer twice
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 a separate set of 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 a separate 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 with the 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.
Allow refunds with no original Linkly payment
By default, Linkly can only refund an order that Linkly was paid on. To let staff refund to a Linkly terminal on an order with no Linkly payment, such as refunding a cash sale back to a card, add this line to the API Options field (s_c__Api_Options__c), alongside any keys already there:
```yaml
refund_without_original_payment: true ```
To turn it off, remove the key or set it to false.
Card (Linkly) then appears as a refund method on any register paired with a Linkly terminal, including on orders that Linkly did not take payment for.
:::warning This removes the link between the refund and an original card payment, so the register cannot check the refund against what was captured. Enable it only where staff are expected to refund to a card that was never charged on the order. :::
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, so 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 |
The POS renews the Linkly session token automatically. It checks the token when you open Linkly at checkout and again before each charge, and renews it if it is missing or within five minutes of expiring, so the terminal does not need re-pairing after the register sits idle overnight. If the Settings > Linkly page shows Token Expired or Disconnected, select Reconnect to restore the session without re-pairing.
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 select Checkout.
- Select Linkly as the payment method.
- (Optional) To charge less than the full amount owing, such as for a split payment, select Take custom amount and enter the amount.
- Select Charge. The button shows the amount, for example Charge $40.00.
- Ask the customer to tap, insert, or swipe their card on the terminal.
While the terminal has the payment, the POS shows the progress (Connecting, Waiting for terminal, Transaction pending) and holds the sale. You cannot leave checkout or choose another payment method until the payment settles or is cancelled, so a card the customer taps is always recorded against this sale.
When the terminal approves the card, the POS shows Finalizing payment, records the payment against the order, and completes the sale once nothing is left owing.
Cancel a payment in progress
- While the terminal is waiting for the card, select Cancel transaction.
- On the Cancel this payment? screen, select Cancel payment. To keep waiting instead, select Back.
The POS asks the terminal to cancel. A cancel cannot stop a card the customer has already tapped, so check the result before you take the payment another way.
| The POS shows | What it means | What to do |
|---|---|---|
| Transaction cancelled | The terminal cancelled the payment. No payment was processed. | Select Charge to try again, or choose another payment method. |
| You cannot cancel a transaction that has already been completed. | The customer paid before the cancel reached the terminal. | Nothing. The payment is recorded as normal. |
| Cancel requested | The terminal did not confirm the cancel, and the charge may still go through. | Check the terminal. If the charge went through, the next Charge for this sale records it instead of charging again. If it is still waiting, charging again can take a second payment. |
If the register is offline, the screen reads Abandon this payment? and the button is Abandon payment. No cancel can be sent, so the payment will most likely go through. The POS shows Payment abandoned. Take the payment another way and refund the terminal charge if it goes through, or wait for the terminal payment to settle and then select Charge, which picks it up instead of starting a new one.
When a payment does not go through
The POS shows one of these messages in place of a completed payment.
| The POS shows | What it means | What to do |
|---|---|---|
Transaction failed, with Linkly’s reason, for example PINpad Offline — no payment processed |
Linkly reported that the payment did not go through. No payment is recorded. | Act on the reason. For PINpad Offline, bring the terminal back online. For a declined card, ask for another card or use another payment method. Then select Charge again. |
| Terminal busy | The terminal was busy with another transaction and did not attempt this one. The POS stopped waiting. | Check the terminal shows no payment went through, then select Charge again. |
| We couldn’t confirm the transaction with Linkly | The request to start the payment failed part way, and the terminal may have processed it. | Select Charge again before you use another payment method. The POS checks the earlier attempt first and does not send a second charge while it is unresolved. |
| We’re having trouble connecting to Linkly | The POS lost contact with Linkly while waiting for the result. | Check the terminal to see whether the payment went through, then select Charge again. The POS picks up the same payment rather than starting a new one. |
| Payment processing failed | The payment could not be processed. | Try again, or use a different payment method. |
If the customer says they were charged anyway, check whether the customer was charged before you take the payment again, so they are not charged twice.
Check whether the customer was charged
A charge that StoreConnect did not record shows up in the terminal’s own transaction list with no
matching payment in Salesforce. Each Linkly payment in Salesforce stores the terminal’s
transaction number in the Response field, for example RRN: 123456789012.
- Open the terminal’s transactions for the day of the sale in your Linkly or acquiring bank portal.
- Find the approved transaction that matches the sale’s amount and time.
- Compare the transaction’s RRN with the RRNs in the Response field of the Linkly payments taken on that register in Salesforce.
- If the RRN matches an existing payment, the charge is already recorded. Do not add it again.
- If no payment has that RRN, open the order in Salesforce and create a payment
(
s_c__Payment__c) in the Payments related list, using the values in the table below.
| Field | Value |
|---|---|
| Payment Provider | Your Linkly payment provider |
| Amount | The amount the terminal charged, including any surcharge |
| Status | success |
| Response | The terminal’s RRN, for example RRN: 123456789012 |
The payment now appears in the order’s Payments related list with the terminal’s RRN in the Response field, so the next person reconciling that register finds the charge already recorded.
Take the payment again
:::warning
Take the payment again from the POS, not by entering the amount on the terminal. StoreConnect never receives a sale started on the terminal, so the customer is charged while the order still shows the amount owing.
:::
- Check the terminal is switched on and connected to the network.
- On the POS checkout, select Charge again.
When the terminal approves the card, the POS records the payment against the order and the checkout no longer shows an amount owing.
Process a refund
- Open the original order and initiate a return.
- Select Refund and choose Linkly as the payment method.
- Confirm the refund amount.
- Select Process refund.
- Ask the customer to present their card on the terminal.
When the terminal approves the refund, the POS records it against the original order.
To stop a refund while the terminal is waiting for the card, select Cancel refund, which shows the refund amount, then select Cancel refund on the Cancel this refund? screen. If the customer has already presented their card, the refund may still go through, and the customer would then already be refunded.
If a payment is interrupted
StoreConnect records every Linkly payment and refund on the server before the terminal is contacted, so the attempt is not lost when the register stops waiting, for example because the browser closed, the network dropped, or you cancelled or abandoned the payment. There is no recovery prompt when the POS restarts. Instead, the POS checks for an earlier attempt each time you select Charge or Process refund for the same sale, so reopen the sale the payment was taken for and select Charge again.
| What the POS finds | What happens |
|---|---|
| An earlier payment for this sale is still with the terminal | The POS shows A payment is already in progress with the amount, and waits for that payment instead of starting a new one. Wait for it to finish, or cancel it to start again. |
| An earlier payment for this sale was approved but never recorded | The POS records that payment without charging the card again, and shows Recovered an earlier approved payment. |
| Nothing outstanding | The POS sends a new payment to the terminal. |
A recovered payment is recorded at the amount the terminal approved, which can differ from what the sale now owes. If it is less, the checkout shows the rest still owing.
For example, a register loses power while the terminal is taking a $40.00 payment, and the customer’s card is approved. When the register is back, the sales assistant reopens the sale, selects Linkly, then Charge $40.00. The POS shows Recovered an earlier approved payment with the message “An earlier payment of $40.00 for this sale was already approved on the terminal, so no new charge was taken.”, and the sale completes.
Refunds
When you select Process refund and a refund for the order is still on the terminal, the POS shows “A refund of $25.00 for this order is already in progress on the terminal. Waiting for it to finish.” and waits for it.
A refund that the terminal approved after the POS stopped waiting is not picked up this way. Before you process the refund again, check the terminal’s transactions for an approved refund of that amount, so the customer is not refunded twice.
If the sale is no longer on the register
The POS can only pick up an earlier payment from the sale it was taken for. If that sale is gone, for example because the cart was cleared, find the charge in the terminal’s transactions and record it against the customer’s order in Salesforce. See Check whether the customer was charged.
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.
Was this article helpful?
Thanks for your feedback! It helps us improve our docs.