# Linkly Source: https://support.storeconnect.com/articles/linkly-payment-provider · Last modified 21 August 2026 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 1. In StoreConnect, go to **Settings > Payments > Payment providers**. 2. 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 1. In StoreConnect, go to your store and open the **Store Variables** section. 2. Select **New**. 3. 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. 1. 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**. 2. In the POS, go to **Settings > Linkly**. 3. Enter the 6-digit pair code. 4. Select **Pair terminal**. 5. 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 | Linkly bearer tokens refresh automatically in the background 15 minutes before they expire. This prevents the daily timeout that previously required cashiers to re-pair their terminal after overnight inactivity. If a token does expire before the automatic refresh completes, 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 1. Add items to the cart and proceed to checkout. 2. Select **Linkly** as the payment method. 3. Confirm the payment amount. 4. Select **Take payment**. 5. The EFTPOS terminal prompts the customer to tap, insert, or swipe their card. 6. The POS polls the terminal automatically until the transaction completes. 7. 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 1. Open the original order and initiate a return. 2. Select **Refund** and choose Linkly as the payment method. 3. Confirm the refund amount. 4. The terminal prompts the customer to present their card. 5. 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](payment-surcharges) for details. --- ## Follow StoreConnect - [Email Newsletter](https://getstoreconnect.com/c/lp-newsletter) - [LinkedIn Newsletter](https://www.linkedin.com/build-relation/newsletter-follow?entityUrn=7444956928444862464) - [YouTube](https://www.youtube.com/channel/UCngKdP2x8l1wcbAKW3tvU8g) - [LinkedIn](https://www.linkedin.com/company/storeconnect) - [X / Twitter](https://x.com/storeconnecthq) ## Popular Links - [Partners](https://getstoreconnect.com/partners) - [News](https://getstoreconnect.com/articles/news) - [Events](https://getstoreconnect.com/articles/events) - [Feature Comparison](https://getstoreconnect.com/how-we-compare) - [Download a free trial](https://appexchange.salesforce.com/appxListingDetail?listingId=a0N3A00000FMkeKUAT) - [Book a Demo](https://getstoreconnect.com/contact) ## Documentation - [Help documentation](https://support.storeconnect.com/help-documentation) - [AI agents](https://support.storeconnect.com/ai) - [Videos & tutorials](https://support.storeconnect.com/videos-tutorials) - [Developer reference](https://support.storeconnect.com/developer-reference) - [Release notes](https://support.storeconnect.com/release-notes) - [Troubleshooting](https://support.storeconnect.com/troubleshooting) - [Trust Center](https://trust.getstoreconnect.com/) - [Status Page](https://status.storeconnect.com/) ## Contact - info@getstoreconnect.com - US +1 415 745 3230 - AUS +61 2 8365 2308 100 S Ashley Dr, Suite 600-2461 Tampa FL 33602-600 USA Level 22, Sydney Place 180 George Street Sydney, NSW, 2000, AUS --- StoreConnect Support — https://support.storeconnect.com/articles/linkly-payment-provider