See what the Square integration can do →
Before You Begin
Before you begin, obtain the access token for your Square application:
Go to the Square Developer Dashboard and sign in with your Square account.
Open Settings > App Integrations, find your application, and click Manage to open its Credentials page.
Select Sandbox for sandbox credentials or Production for production credentials. The credentials are different for each environment.
Copy the Access Token. You enter it when configuring the subscription.
Installation Instructions for Integration Setup
Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.
Click the Square integration tile.
Click Subscribe.
Enter a Name for the subscription and select a Version. Use a unique, relevant name within your company — for example,
Square - Production.
Enter the API URL for your environment:
Production:
https://connect.squareup.comSandbox:
https://connect.squareupsandbox.com
Enter the Access Token you copied from Square. Sandbox and production access tokens are different — if you switch environments, update this value.
Select a value for Enable Version Control. When blank or False, version control is inactive. When True, the integration fetches the latest product and variant versions from Square before applying an update, so updates are applied to the current catalog state and version-mismatch errors are avoided.
Select a value for Match Different Case Product Options and Values. When blank or False, product options and values are matched case-sensitively, and a casing difference can cause Square to report a duplicate. When True, matching ignores letter casing, existing Square option and value names are reused, and existing option-value colors are preserved when the incoming data does not include them.
Enter the API Throttle Limit — the maximum number of requests the integration may run within the throttle window. This field is pre-populated by the integration.
Enter the API Throttle Seconds — the time window over which the API Throttle Limit is measured.
Default: 60
Enter the Concurrent Connections — the maximum number of simultaneous API connections to Square.
Default: 5
Range: up to 10
Enter the Concurrent Batch Executions — the maximum number of simultaneous batch executions for the integration.
Default: 5
Range: up to 10
Click Apply to save the settings.
Authentication Configuration
Square uses OAuth 2.0. After the subscription is created and the settings are applied, complete the one-time authorization to grant iPaaS.com access to Square:
Open the Square subscription and click the Authentication icon in the top toolbar. A new browser window opens.
Sign in to your Square account and choose the application to authorize. Square displays an access-authorization screen.
Click Allow. Square confirms the authorization is complete.
Close the authorization page, then refresh your subscription page. The Refresh and Access tokens are then present on the subscription.
NOTE: Square access tokens are short-lived. When the access token expires, the integration uses the stored Refresh token to obtain a new one automatically, so no periodic re-authorization is required. If the authorization is revoked in Square or the refresh token is removed, repeat the steps above.
Operational Configuration
Two subscription settings control catalog-write behavior and can be adjusted at any time:
Enable Version Control: set to True to have the integration apply product and variant updates against the latest Square catalog version, preventing version-mismatch errors. Recommended when products are also edited directly in Square.
Match Different Case Product Options and Values: set to True so product options and values match existing Square options regardless of letter casing, preventing duplicate options. Set it to match how your Square catalog is maintained.
Post-Installation Verification
After completing the installation, verify the connection:
Authorization: Confirm the Refresh and Access tokens are present on the subscription after the authorization step above.
Data sync: From the Manual Sync page, record a known Square order or customer to iPaaS.com (TO iPaaS.com), or write a known iPaaS.com product to Square (FROM iPaaS.com), and confirm the record appears in the destination system.
Review logs: Open Dashboard > Integration Monitoring > Error Logs and confirm the transfer completed without errors.
Error Messages
For the error messages you may encounter during synchronization and how to resolve them, see the Square Error Messages article.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or search the documentation.
Support Portal: https://support.ipaas.com/en/
Contact Information: https://ipaas.com/contact-us/