Documentation Index
Fetch the complete documentation index at: https://docs.alterauth.com/llms.txt
Use this file to discover all available pages before exploring further.
Overview
Connect your users to Square for payment processing, inventory management, order tracking, and customer data.| Property | Value |
|---|---|
| Provider ID | square |
| Category | Payments |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a Square OAuth App
Go to the Square Developer Portal
Navigate to developer.squareup.com/apps and sign in.
Create a new application
Click Create your first application (or + to add another), enter the app name, and click Save.
Configure the redirect URI
Under OAuth, add the Alter callback URL from the Developer Portal to the Redirect URL field.
Step 2: Add to Alter Vault
Open the Developer Portal
Go to portal.alterauth.com and navigate to your app.
Enter credentials
- Client ID: Paste your Square Application ID
- Client Secret: Paste your Square Application Secret
Available Scopes
| Scope | Description |
|---|---|
MERCHANT_PROFILE_READ | Read merchant profile and business info |
PAYMENTS_READ | Read payment records |
PAYMENTS_WRITE | Create and process payments |
ORDERS_READ | Read order data |
ORDERS_WRITE | Create and manage orders |
ITEMS_READ | Read catalog items and inventory |
ITEMS_WRITE | Create and manage catalog items |
CUSTOMERS_READ | Read customer profiles |
CUSTOMERS_WRITE | Create and manage customers |
Notes
- Square has separate sandbox and production environments. Use sandbox credentials during development.
- See the Square OAuth API documentation for more details.