> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Square

> Integrate your application with the Square API

## 🚀 Quickstart

Connect to Square with Nango and see data flow in 2 minutes.

**1. Create the integration**

In Nango ([free signup](https://app.nango.dev)), go to [Integrations](https://app.nango.dev/dev/integrations) -> *Configure New Integration* -> *Square*.

**2. Authorize Square**

Go to [Connections](https://app.nango.dev/dev/connections) -> *Add Test Connection* -> *Authorize*, then log in to Square. Later, you'll let your users do the same directly from your app.

**3. Call the Square API**

Make your first request to the Square API (e.g. list locations). Replace the placeholders below with your [Environment API key](https://nango.dev/docs/reference/backend/http-api/api-keys.md), [integration ID](https://app.nango.dev/dev/integrations), and [connection ID](https://app.nango.dev/dev/connections):

> [tab] cURL
>
> ```bash theme={null}
> curl "https://api.nango.dev/proxy/v2/locations" \
>   -H "Authorization: Bearer <NANGO-API-KEY>" \
>   -H "Provider-Config-Key: <INTEGRATION-ID>" \
>   -H "Connection-Id: <CONNECTION-ID>"
> ```

> [tab] Node
>
> Install Nango's backend SDK with `npm i @nangohq/node`. Then run:
>
> ```typescript theme={null}
> import { Nango } from '@nangohq/node';
>
> const nango = new Nango({ apiKey: '<NANGO-API-KEY>' });
>
> const res = await nango.get({
>     endpoint: '/v2/locations',
>     providerConfigKey: '<INTEGRATION-ID>',
>     connectionId: '<CONNECTION-ID>'
> });
>
> console.log(res.data);
> ```

Or fetch credentials with the [Node SDK](https://nango.dev/docs/reference/backend/backend-sdk/node.md#get-a-connection-with-credentials) or [API](https://nango.dev/docs/reference/backend/http-api/connections/get.md).

✅ You're connected! Check the [Logs](https://app.nango.dev/dev/logs) tab in Nango to inspect requests.

**4. Implement Nango in your app**

Follow our [Auth implementation guide](https://nango.dev/docs/guides/primitives/auth.md) to integrate Nango in your app.

To obtain your own credentials, follow the setup guide linked below.

## 📚 Square Integration Guides

Nango maintained guides for common use cases.

* [How to register your own Square OAuth app](https://nango.dev/docs/api-integrations/squareup/how-to-register-your-own-squareup-oauth-app)\
  Register your own OAuth app and configure Square for production use in Nango

Official docs: [Square API documentation](https://developer.squareup.com/reference/square)

## 🧩 Pre-built syncs & tools for Square

Explore Nango-provided tools in your dashboard. Extend and customize them to fit your needs.

### Others

| Function name | Description | Type |
| - | - | - |
| `batch-retrieve-catalog-objects` | Retrieve multiple catalog objects by ID in one call. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `cancel-invoice` | Cancel a published, unpaid invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `cancel-payment` | Cancel (void) a payment that has not yet been captured. Only works on payments in APPROVED status. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `cancel-subscription` | Cancel a subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-customer` | Create a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-invoice` | Create an invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-order` | Create an order. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-payment` | Create a payment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-subscription` | Create a subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-team-member` | Create a team member. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-catalog-object` | Delete a catalog object (and its child objects, e.g. variations). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-customer` | Delete a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-invoice` | Delete a draft invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-customer` | Retrieve a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-invoice` | Retrieve an invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-order` | Retrieve one or more orders by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-payment` | Retrieve a payment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-refund` | Retrieve a refund. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-subscription` | Retrieve a subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-team-member` | Retrieve a team member. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-customers` | List customers. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-invoices` | List invoices. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-locations` | List locations. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-orders` | Search orders. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-payments` | List payments. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-refunds` | List refunds. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `pause-subscription` | Pause an active subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `pay-order` | Pay an order. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `publish-invoice` | Publish a draft invoice, moving it out of DRAFT status and sending it to the recipient. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `refund-payment` | Refund a payment. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `resume-subscription` | Resume a paused or deactivated subscription. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `retrieve-catalog-object` | Retrieve a single catalog object by ID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-catalog-objects` | Search catalog objects. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-customers` | Search customers by filters (email, phone, name, etc). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-subscriptions` | Search subscriptions. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-team-members` | List/search team members. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-customer` | Update a customer. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-invoice` | Update a draft or unpaid invoice. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-order` | Update an order (e.g. add line items, discounts, service charges). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-subscription` | Update a subscription (e.g. swap card\_id). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-team-member` | Update a team member (e.g. name, status, assigned locations). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `upsert-catalog-object` | Create/update catalog object. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `catalog-objects` | Sync catalog objects | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `customers` | Sync customers. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `invoices` | Sync invoices. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `locations` | Sync locations. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `orders` | Sync orders. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `payments` | Sync payments | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `refunds` | Sync refunds. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `subscriptions` | Sync subscriptions. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `team-members` | Sync team members. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.