canonical: https://jentic.com/apis/square.com/square

# Square

Use Square APIs to manage and run business including payment, customer, product, inventory, and employee management. The API exposes 327 endpoints secured with apiKey, oauth2 authentication.

## For AI agents

Programmatically createmobileauthorizationcode, revoketoken. Covers 327 operations with apiKey, oauth2 authentication.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- CreateMobileAuthorizationCode
- RevokeToken
- ObtainToken
- RetrieveTokenStatus
- V1ListOrders
- V1RetrieveOrder
- V1UpdateOrder

## Use cases

### E-Commerce Operations

Use the Square to perform e commerce operations programmatically. The API provides 327 endpoints covering core functionality including createmobileauthorizationcode, revoketoken, obtaintoken.

Example prompt: Call POST /mobile/authorization-code to createmobileauthorizationcode

### Automated Apple Pay Management

Automate apple pay operations by combining multiple Square endpoints. Agents can revoketoken and then obtaintoken in a single workflow.

Example prompt: Call POST /oauth2/revoke to revoketoken, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Square endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey, oauth2 tokens manually.

Example prompt: Search Jentic for 'createmobileauthorizationcode', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /mobile/authorization-code | CreateMobileAuthorizationCode |
| POST | /oauth2/revoke | RevokeToken |
| POST | /oauth2/token | ObtainToken |
| POST | /oauth2/token/status | RetrieveTokenStatus |
| GET | /v1/{location_id}/orders | V1ListOrders |
| GET | /v1/{location_id}/orders/{order_id} | V1RetrieveOrder |
| PUT | /v1/{location_id}/orders/{order_id} | V1UpdateOrder |
| POST | /v2/apple-pay/domains | RegisterDomain |

## Key resources

- **Apple Pay** — Operations for apple pay
- **Bank Accounts** — Operations for bank accounts
- **Bookings** — Operations for bookings
- **Cards** — Operations for cards
- **Cash Drawers** — Operations for cash drawers

## Why Jentic

- **Setup:** Wiring Square by hand means running its OAuth 2.0 flow against connect.squareup.com, refreshing tokens, and threading the location id into order paths yourself. Through Jentic you install once, import Square from the API Directory, store the credentials once, and your agent calls it.
- **Permission scoping:** Square puts the location id in the URL path (/v1/{location_id}/orders/...), so a rule can pin your agent to one location: it can read and update orders there and nothing else. You choose the operations it may call, so ones like updating an order are not included unless you add them.
- **Credential handling:** Your Square OAuth credentials are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list orders for this location' or 'get an order by id', and Jentic returns the matching Square operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Square use?

The Square uses apiKey, oauth2 authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I createmobileauthorizationcode with the Square?

Yes. Use the POST /mobile/authorization-code endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Square?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I createmobileauthorizationcode through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'createmobileauthorizationcode'. Jentic returns the matching Square operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Square have?

The Square exposes 327 endpoints covering apple pay, bank accounts, bookings operations.

### Can I limit what my agent is allowed to do with the Square API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Square operations and credentials the agent may use. Because Square puts the location id in the URL path, such as /v1/{location_id}/orders, you can pin the agent to a single location and let it read orders there while excluding everything else. You choose which operations it may call, so an operation like V1UpdateOrder is only available if you add it.