Square Installation Instructions

Go to Square and log in with your Square account credentials.

On the Square Home page, choose your account and then click Settings.

On the Settings page, click App Integrations.

On the My Applications page, find your application and click Manage. Square displays the Credentials page.

Select Sandbox for sandbox server credentials or Production for production server credentials. Note that the credentials are different for each environment.
​

Copy the Access Token. You will need this to complete setting up your subscription. The access token is the only credential you need to create and install a Square subscription.

Go to Subscriptions Management > Subscriptions and click Search Certified Integration Marketplace and Subscribe.

Click the Square Integration title.

Click the Subscribe button.

Enter the Name of the subscription and select a Version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
​

Enter the API URL for the environment:

Enter the Access Token you saved from Square. ​If you change from Sandbox to Production, remember that the Access Tokens are different.

Select a value for Enable Version Control. When no value is entered or is False, version control is inactive. When set to True, the system ignores the version provided in the external ID and first fetches the latest product from Square. It then uses the most recent product and variant versions while performing the update, ensuring that the update is always applied to the latest catalog state and preventing version-mismatch errors.

Select a value for Match Different Case Product Options and Values. This preset controls whether product options and values are matched using case-sensitive or case-insensitive logic when syncing with Square. When no value is entered or is False, matching is case-sensitive, and differences in letter casing can result in duplicate option or value errors from Square. When set to True, matching is case-insensitive. Existing Square option and value names are reused to prevent duplicates and preserve Square’s canonical naming. When enabled, existing color hex codes on Square option values are preserved if the incoming data does not include them, preventing accidental data loss.

Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.

Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.

Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that Square can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.

Click Apply to save the settings.

Go to the Square subscription that was created

Click the Authentication icon found in the top toolbar.

A new browser window opens.

Sign in to your Square account and choose the app you want to authorize. Square. Square displays an access authorization screen.
​

Click Allow. If successful, Square displays an Authorization complete message.

Click Close Page.

Refresh your subscription page. The Refresh and Access tokens should be present.​

Initiate a sample data pull. (To iPaaS.com)

Initiate a sample data push. (From iPaaS.com)

Run an end-to-end business process.

Validate key features like field mappings, workflow triggers, and logging.

Review integration logs in iPaaS.com.