Square Logo

Square API Integration Profile

Information and guides about integrating with Square API

Add Square Integration to Your Product

Configuration

Create a Developer Account

To create a Square developer account and oAuth application,
follow this documentation: Create an Account and Application.

This will be enough to develop and test your integration. Before publishing it to your customers, you will need to activate your Square account.

Create an oAuth App

  1. Go to the Square Developer Console and create a new app.

  2. Go to the oAuth page and put the following into the Redirect URI field for both sandbox and production: https://api.integration.app/oauth-callback.

  3. Save Application Id and Application Secret for both sandbox and production - you will need them to configure the integration.

  4. (optional) Create a webhook subscription if you want to receive real-time events from Square. You can find the notification URL on your Square integration page. Use it to subscribe to all the event types you want to receive. You can use the same webhook URL for both sandbox and production configuration.

Configure the app parameters in the integration.app platform

  • Add the Square app from store in the Integration.app console
  • Click Configure & Test
  • In the Parameters section, select a Use custom parameters toggle / Edit Parameters
  • Fill in Client Id and Client Secret with the Application Id and Application Secret you obtained earlier
  • Add scopes your application may require

Testing

Create Test Account

After you created a Square developer account and added an oAuth application, you will automatically get a Sandbox test account you can find here: Sandbox Accounts. You should use these accounts to test the integration.

Build every single integration your customers need with AI

Book a demo