> ## Documentation Index
> Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up Loyverse

> Prepare a compatible Points card, set Loyverse earning to 0%, connect the businesses and test the complete journey.

Complete every step before serving customers. Perkstar keeps earning and till
redemption off until the required card, scanning and balance checks are ready.

## Before you connect

* Confirm Perkstar and Loyverse use the same currency. Till redemption requires
  a currency with two decimal places.
* Sign in as a Perkstar owner or manager and use a plan that includes Loyverse.
* Make sure you can approve apps for the intended Loyverse business.
* Decide whether any existing Loyverse loyalty balance must be exported or
  migrated.
* Keep every POS device online while configuring and testing it.

<Warning>
  When till redemption is activated, Perkstar clears existing Loyverse customer
  points balances, verifies the clearing and then publishes only each customer's
  spendable Perkstar balance. Export or migrate value you need to keep before
  confirming activation.
</Warning>

## Prepare the Points card

The card picker shows eligible cards under **Ready to connect**. Cards under
**Needs changes** cannot be selected and include an **Edit** link explaining
what to fix.

A compatible card must be:

* active and unarchived;
* a Points card for individual customers, not a group-enrolment card;
* configured to earn automatically by spend or visit, rather than by manual
  points entry;
* configured with an ongoing Points-to-Cash balance and a valid conversion;
* set to flexible spending with a positive minimum balance before spending;
* configured to display a QR code; and
* configured to require **First name** and **Email** on the sign-up form.

<Note>
  Stamp cards, reward-level Points cards, set-amount Points-to-Cash cards,
  group-enrolment cards and manual-earning cards cannot be connected. Flexible
  Points-to-Cash is required because a cashier can enter any eligible amount up
  to the available balance.
</Note>

## Set Loyverse earning to 0%

<Steps>
  <Step title="Open Loyverse Back Office">
    Sign in to the same Loyverse business you will connect to Perkstar.
  </Step>

  <Step title="Open Loyalty settings">Go to **Settings → Loyalty**.</Step>

  <Step title="Save zero percent">
    Set the loyalty earning percentage to **0%**, then select **Save**.
  </Step>
</Steps>

This setting applies across the Loyverse account. Perkstar cannot read or change
it through the Loyverse API, so you must confirm it during activation and leave
it at 0% while the integration is live. See [Loyverse's loyalty
instructions](https://help.loyverse.com/help/how-customer-loyalty-program).

## Connect and activate

<Steps>
  <Step title="Connect the correct businesses">
    [Start the Loyverse
    connection](https://dashboard.perkstar.co.uk/install/loyverse), sign in to
    Perkstar and choose the business if asked. Authorise access to Loyverse
    business details, customers and receipts. On return, check the Loyverse
    business name and currency before continuing.
  </Step>

  <Step title="Choose the Points card">
    Select the intended card under **Ready to connect**, then choose **Use this
    card with Loyverse**. Use the guided **Edit** link if a card is under
    **Needs changes**.
  </Step>

  <Step title="Enable customer card scanning">
    Read and confirm the customer data-sharing notice, then choose **Enable
    customer card scanning**. Perkstar links one existing exact-email Loyverse
    profile or creates an eligible profile when none exists, and publishes the
    managed Wallet QR identifier.
  </Step>

  <Step title="Configure every POS device">
    In Loyverse POS, open **Settings → General** and enable **Use camera to scan
    barcodes**, unless the device uses a compatible external scanner. Tap **Add
    customer**, scan a test Wallet card and confirm the correct customer opens.
    Repeat this on every new or replacement device.
  </Step>

  <Step title="Enable till redemption">
    Confirm separately that every device can scan, Loyverse is set to 0%, and
    existing balances may be replaced. Choose **Enable till redemption** and
    allow about 20 minutes. Activation includes a required 15-minute safety wait
    between two balance checks; larger customer lists or temporary Loyverse
    delays can take longer. You can leave the page after starting because
    Perkstar continues safely in the background. Do not serve customers until
    the page says scanning, earning and redemption are connected.
  </Step>
</Steps>

## Customer information used for scanning

When scanning is enabled, Perkstar sends the customer's name, email address,
optional phone number and managed Wallet scan identifier to Loyverse. Customer
reference IDs, receipts, redemptions and balance data are exchanged to run the
integration. The business must tell customers about this sharing and have an
appropriate lawful basis.

* [Perkstar privacy policy](https://dashboard.perkstar.co.uk/privacy)
* [Integration recipients](https://dashboard.perkstar.co.uk/dpa/sub-processors)

## Test before going live

Use a synthetic customer and record the expected result for the connected
card's exact earning and conversion rules.

1. Scan the Wallet card through **Add customer**, attach the customer and
   complete one paid sale without redemption.
2. Confirm points were added once and the Wallet fields updated.
3. Complete another sale and redeem a smaller amount, such as £1.25 from a
   larger available balance.
4. Confirm precisely that amount was deducted—not pennies and not the complete
   balance.
5. Refund the second sale against its original receipt and confirm the eligible
   correction was applied once.

Continue with the [staff checkout guide](/integrations/loyverse/checkout).


## Related topics

- [Loyverse POS](/integrations/loyverse/index.md)
- [Refunds and troubleshooting](/integrations/loyverse/refunds-troubleshooting.md)
- [Use Loyverse at checkout](/integrations/loyverse/checkout.md)
- [Synchronise customers](/guides/customer-sync.md)
- [Build a POS integration](/guides/pos.md)