OAuth providers
Square
Set up Square OAuth for payment processing and commerce management
Overview
Section titled “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
Section titled “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.
Get credentials
Copy the Application ID (Client ID) and Application Secret (Client Secret) from the Credentials tab.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add Square provider
Go to OAuth Providers > Add Provider > Square.
Enter credentials
- Client ID: Paste your Square Application ID
- Client Secret: Paste your Square Application Secret
Select scopes
Choose the scopes the application needs.
Save
Click Save. The provider is now active.
Available Scopes
Section titled “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 |
- Square has separate sandbox and production environments. Use sandbox credentials during development.
- See the Square OAuth API documentation for more details.