> For the complete documentation index, see [llms.txt](https://docs.boomerangme.cards/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.boomerangme.cards/integrations/square-loyalty.md).

# Square Loyalty

Connect integration with Square. Sync Square Loyalty customers, points and rewards with a Boomerang reward card

Boomerang has two Square integrations. Pick the one that matches what you need:

|                       | **Square Loyalty** (this page)                                                   | [**Square POS app**](https://docs.boomerangme.cards/marketplace/square-pos-app)            |
| --------------------- | -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| What it does          | Keeps customers, points and rewards in sync between Square Loyalty and Boomerang | Adds stamps, points, cashback or discount to a Boomerang card for purchases paid in Square |
| Card types            | Reward                                                                           | Stamp, reward, cashback, discount                                                          |
| Square Loyalty needed | Yes                                                                              | No                                                                                         |
| Setup                 | Sign in to Square from Boomerang                                                 | Create a Square developer app, enter its credentials in Boomerang, add a webhook           |

**Important:** don't connect the same card to both integrations. A purchase would earn points twice: once from the app, and once more from Square Loyalty itself.

### Before you start

* You need a Square account with an active **Square Loyalty** program. In the Square Dashboard, go to **Loyalty → Settings**, set how customers earn points, add at least one reward, and select the locations where loyalty is used. Without a loyalty program the integration stays **Inactive**.
* Square Loyalty accounts are identified by phone number. Customers need a real phone number in international format.

### Connect the integration

1. In Boomerang, go to **Settings → Integrations**.
2. In **Add integration**, find **Square** and click **Connect**. You are redirected to your Square account.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FKGMDUFmzQdUZXaEzcesU%2FScreenshot%20at%20Jan%2029%2014-11-34.png?alt=media&amp;token=d5b54b0e-6622-4468-9b5b-008988c01444" alt=""><figcaption></figcaption></figure>

3. Sign in to the Square account that runs your loyalty program.&#x20;
4. Square shows the permissions Boomerang asks for: view and modify customer information, view gift card information, view merchant profile information, view, create and update loyalty information, view orders, and view payment history. Click **Allow**.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FYSLtO4XDahZBsKakSRNl%2Fimage.png?alt=media&amp;token=d77a7b67-ae1d-4349-bac3-996461ef07ea" alt=""><figcaption></figcaption></figure>

5. You are taken back to Boomerang. A green **Success** message appears in the top-right corner. **Square** appears in **Active integrations** with the status **Active** and your Square merchant ID under its name.

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FoCKklVBGB9c5D3iryZVZ%2Fimage.png?alt=media&amp;token=0f3e1f89-c44d-4b42-859c-7640e1c85ba9" alt=""><figcaption></figcaption></figure>

A Square account can be connected to only one Boomerang account.&#x20;

### The reward card

When you connect, Boomerang creates a new **reward** card for the integration. Its name appears in the **Template name** column. **Square Loyalty works only with reward cards.**

<figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2F11YDFxJEIglexKLcwHKv%2Fimage.png?alt=media&amp;token=46a61204-dab6-44ac-8cb7-fa98197e5d60" alt=""><figcaption></figcaption></figure>

* **The card is created inactive.** Open **Cards**, check the design and click **Activate** before you share it with customers.
* The phone field on the card issuing form is already required. Keep it that way: without a phone number, the customer can't be created in Square.
* **Rewards come from Square.** Each Square reward becomes a reward level on the card with the same name and the same number of points:

  * "$ off the entire sale" becomes an **Order ($ off)** reward with the same amount.
  * "% off the entire sale" becomes an **Order (% off)** reward with the same maximum discount.
  * Rewards for specific items or categories become **Custom** rewards. They have a description only, and staff apply them at checkout.

  The reward conditions have been updated from the settings in Square

  <figure><img src="https://121681468-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FBfW4nnOu4AysbkbyxNug%2Fuploads%2FleCE5Y0RKebnynh0XVem%2Fimage.png?alt=media&amp;token=0e541e1e-6dc9-45f2-80dd-b42a44de65e6" alt=""><figcaption></figcaption></figure>
* **Edit rewards in Square, not in Boomerang.** When you change the loyalty program in Square, Boomerang updates the reward levels and overwrites any changes made in Boomerang. Rewards you delete in Square are deleted from the card.

Activate the card template, and that completes the integration.

### How syncing works

**Customers created in Square.** When a customer joins your loyalty program in Square, Boomerang creates a customer with the same name, phone and email and issues them the integration's card. Boomerang doesn't send these customers a link to install the card. To get them to add the card to their phone, promote the card's QR code or link.

**Cards issued in Boomerang.** When a customer gets the card in Boomerang (through the QR code, the link or a referral), Boomerang finds the Square customer with the same phone number, or creates one, and opens a Square Loyalty account for them. Customers without a phone number aren't synced to Square.

**Points.** Points earned or redeemed in Square update the Boomerang card. This covers purchases, rewards redeemed in Square POS, manual adjustments and expired points. Points added or deducted in Boomerang are sent to Square as point adjustments. This covers the Scanner app, referral bonuses and rewards redeemed in Boomerang.

**Note:** a reward redeemed in Boomerang appears in Square as a points deduction, not as a redeemed Square reward.

### Settings

Click the edit icon next to the integration.

**Data priority** decides what happens when a customer's details differ between Square and Boomerang:

* **Integration** (default): when a customer changes in Square, Boomerang updates their first name, last name, birthday, phone and email from Square.
* **Boomerang**: Boomerang keeps its own customer details.

This setting works in one direction only. Boomerang never updates customers that already exist in Square.

### Deactivating or Removing an Integration

* **Deactivate** stops syncing.
* **Delete** is available only after you deactivate the integration. Deleting it revokes Boomerang's access to your Square account. The card, the customers and their points stay in Boomerang.
* If you remove Boomerang from the app integrations in your Square account, Boomerang deletes the integration on its side. To start syncing again, connect Square again from Boomerang.

### Why the integration isn't working

* **The integration status is Inactive.** Your Square account has no loyalty program. Create one in **Loyalty → Settings**, delete the inactive integration and connect again.
* **Customers aren't created in Square.** The phone number is missing, isn't in international format, is fictitious, or another Square Loyalty account already uses it.
* **Square Loyalty isn't active on your Square account.** Check the Loyalty section in your Square Dashboard.
* **Square Loyalty isn't available in your country.** Check Square's list of supported countries.
* **Loyalty → Settings in Square has no locations selected.**
* **You signed in to the wrong Square account.** Deactivate and delete the integration, then connect again and sign in to the right account.
* **"Already connected to another account".** This Square account is already connected to a different Boomerang account. Contact support.
* **Boomerang was removed in Square.** The integration was deleted on our side. Connect Square again from Boomerang.

❗️❗️❗️We recommend using valid phone numbers for testing, otherwise customers are not created in the Square.
