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

# Square

Use Square customers, orders and transactions for loyalty earning and configured referral lead delivery.

## Integration at a glance <a href="#capabilities-and-use-cases" id="capabilities-and-use-cases"></a>

* **Purchases** — Filter earning by product/catalog and customer group; refund handling is supported.
* **Referral leads** — A configured workflow can send Perkville referral leads to Square.
* **Redemption** — Automatic reward fulfillment at the Square POS is not included in the listed integration.

Your configured rules determine which eligible activities award points and which workflows are enabled.

## Integration Steps

* Your **Customer Success Representative** will send you an email invitation to join our integration platform, **Middle**.
  * Follow the link in the email and **complete registration** by setting a password.
* Once logged in to Middle:
  * Click **“Add New Connection”**
  * **Click "Square" and "Add Connection"**
  * Add the name of the connection, like "Business Name"
  * Click **“Save”**
  * Then click **“Launch OAuth Flow”** > **“Launch OAuth Process”**
* You will be redirected to sign in to your system.
  * After signing in, you should be returned to Middle with an **“OAuth Success”** message.
  * If you are not redirected or do not see this message, please contact your Customer Success Representative for assistance.

## What to expect after connecting Square

Connecting Square authorizes Middle to access the Square account. It does not, by itself, guarantee that every sale earns points or that rewards can be redeemed at the Square register. Your Perkville Customer Success Representative will confirm which transaction types, locations, and earning rules are included in your integration setup.

Before launching, review these questions with your Success Representative:

* **Customer matching:** Which customer identifiers (such as email or an external customer ID) are used to associate Square activity with the correct Perkville profile?
* **Point earning:** Which completed purchases or other Square events qualify, and when will they appear in Perkville?
* **Unmatched activity:** How will transactions without sufficient customer information be handled, and what should staff do if a transaction is missing?
* **Redemption:** Does your configured integration support redemption directly at the Square POS, or will staff fulfill Perkville rewards separately?

After setup, complete a test purchase using a designated test customer and verify the result on that customer's Perkville profile. See [Customer profiles](https://docs.perkville.com/features/customers.md) and [Perkville Support](https://docs.perkville.com/overview/support.md) for additional help.

{% hint style="info" %}
Capabilities vary by integration configuration. Ask your Success Representative to confirm supported workflows rather than assuming that every Square integration includes two-way rewards redemption.
{% endhint %}

## FAQ

### Can Perkville send referral leads to Square?

Yes, with a configured lead workflow. Confirm matching, destination and fields with your CSR before enabling it.

See the [Square partner profile](https://partners.perkville.com/partners/square) for additional integration information.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.perkville.com/integrations/integration-reference/square.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
