Square Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Square connector.

This topic describes how to authenticate to Square and configure any necessary connection properties in the Square connection connector.

Connection Configuration #

Each connection property available in the Square connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme #

The type of authentication to use when connecting to Square.

Possible Values

• OAuth2: Set to this to perform the OAuth 2.0 authentication.

• Access Token: Set this to perform Token Based Authentication via the AccessToken property.

  💡

  The AccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
  The access token is used in place of your username and password. The access token protects your credentials by keeping them on the server.

OAuth2 #

If OAuth2 is selected, additional configuration parameters will get listed.

Client ID #

The client Id assigned when you register your application with an OAuth authorization server.

Client Secret #

The client secret assigned when you register your application with an OAuth authorization server.

Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

Access Token #

If Access Token is selected, provide the access token for connecting to Square.

Schema #

Specify the API version to use.

Use Sandbox #

A boolean indicating if you are using a Sandbox account.

If you are using a production account, this property can be left with default value as False.

If you are using a developer test account, set this to TRUE.

Location ID #

The Id of one of your business locations that will be set as default.

This can also be set in the search criteria of the query.

A value set in the query overrides the value set in this connection property.

You can retrieve the Ids for your Locations by querying the Locations table.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.