Articles in this section

Set up a connection to Square

Square is a payments and business management platform designed for businesses to accept payments, manage sales, and run day-to-day operations.

Set up a connection 

After you start the connection, configure it in the Create connection panel and complete all of the required * authentication settings:

Setting Instructions
Name your connection * 

Enter a clear and distinguishable name.

Throughout integrator.io imports and exports, you will have the option to choose this new connection. A unique identifier will prove helpful later when selecting it from a list of the connections in your account.

Account type * 

Select your Square account type:

  • Production: if your Square account URL is https://connect.squareup.com.
  • Sandbox: if your Square account URL is https://connect.squareupsandbox.com.
OAuth 2.0 client * 

Select the OAuth 2.0 client that stores the client ID and client secret provided to you by Square. This option is available only when you select the Account type as Sandbox.

For detailed information on retrieving the client ID and client secret, see Credentials.

To add an OAuth 2.0 client and configure your credentials, click the plus ( + ) button. Click the edit (pencil.svg) button to modify a selected OAuth 2.0 client. For more information, see Create an OAuth 2.0 iClient resource.

Scopes * 

Scopes are OAuth 2.0 permissions that Square defines to limit access to your account.

How to configure scopes 

Tip

This connector documentation describes only the settings shown for the Simple view. For the corresponding HTTP settings, see the OAuth 2.0 auth universal connector documentation.

How to configure the scopes

  1. Click the Configure scopes button.
  2. To access all of the scopes in the API, click the » button.
    – or –
  3. Check the scopes you want to add, and click the > button.
  4. Click Save to save your scopes and leave the editor.

Important

You must add the scope MERCHANT_PROFILE_WRITE in order for the connection to succeed.

Save and authorize

To save and authorize the Square connection:

  1. Click Save & authorize to save your changes and proceed to sign in with Square.
  2. Enter the email address and password of your registered Square account.
  3. Click Sign in.
  4. Review the permissions and click Allow to grant permission and establish the connection.

Additional references