Get Started with Square Integrations
This is pre-release documentation for an API in public beta and is subject to change.
Learn whether your business is a fit for a Square integration by contacting Square for a demo, scheduling a consultation with a Square account executive, and completing all Square Bridge prerequisites. When all the prerequisites are met, you can onboard with Square Bridge.
Not every seller can create a Square integration. In some cases, the seller's external system is not yet supported by the Square Bridge integration tool. Other sellers might be hesitant to set up a sandbox environment in their external system, which is a necessity for Square Bridge. There might be other disqualifying factors that are discovered in your discussion with your account executive.
You need to schedule a demo with your account executive. During the demo, you can see the features of a Square integration and get an opportunity to talk with Square integration onboarding experts. They can help determine what Square Bridge can do for you.
In cases where a Square integration is not a fit, there might be other integrations available through partners or sellers could build a custom integration using the Square API. Contact your account executive to understand different ways to integrate your external system to Square and determine which makes the most sense for your business.
Square assigns your account executive or account manager. For these instructions, these roles are the same. Square uses the title account executive to refer to the Square employee.
The Deal Support Request (DSR) is a collection of correspondence that describes the state of your deal with your account executive. It is continually updated throughout the requirements and scoping phases.
Initiate a DSR. Contact your Square Sales account executive and ask them to file a DSR for Square Bridge.
Requirements gathering and scoping. Your account executive contacts you to schedule a requirements gathering call. This is a technical call, which involves experts from your team and the Square Bridge team to evaluate your specific needs.
This is followed by additional scoping calls, as needed, between your team and the Square Bridge team to refine the integration needs and assess how Square Bridge can help you.
Start the integration. Integration begins after a successful scoping call. Your account executive and the Square Bridge team provide you with your start date.
To complete the onboarding process, you need up to five sets of credentials (usernames and passwords) for the accounts used with Square Bridge. You need to provide:
Two Square Accounts. One for testing and one for production.
Two ERP environments. One for testing and one for production. Some external systems require an account for each environment.
One Google or Microsoft account for signing in to the Square Bridge integration application.
You must verify and collect all these accounts before starting the integration.
Square asks for a separate Square account for testing because the Square Sandbox is intended to be a developer-facing tool. Square Bridge is an end-to-end solution that typically does not require development by sellers. By having a separate account for testing, transactions do not flow to your production ERP system and interfere with your financial reporting.
Ensure that you have credentials to access two Square accounts: one for production usage and one for testing purposes.
To confirm access and verify that you have sufficient credentials in your Square accounts, do the following in each account:
Sign in to the Square account.
In the Square Seller Dashboard, open the Team application.
In the list of team members, choose yourself.
In the information window that opens on the right side of the page, review your assigned permissions. If the permission set shows Owner or permissions show Full access, you have sufficient credentials. Otherwise, review the following list of permissions for which Square Bridge asks your authorization.
After you are approved for a Square integration, the onboarding process takes place in the following phases:
Run the Square Bridge integration to create an integration (see Using Square Bridge).
Test your integration in a testing environment (in both Square and your external system).
When onboarding is complete, you have created a fully functioning sandbox integration for testing and evaluation.
To start a new integration, run Square Bridge and answer the prompt to sign in using a Google or Microsoft email address.
Sign up with a Google or Microsoft account. If you want to use a Google account and do not have one, see Create a Google Account.
On successful authentication, you are prompted to agree to the Square terms of service. Accept the terms of service and choose Submit to continue.
For security reasons, following 30 minutes of inactivity, you are automatically signed out of Square Bridge.
You are prompted to create your first Square integration with your ERP system.
In Square Bridge, choose the Create Integration button to run the onboarding wizard that links a Square account with your external system account. The wizard walks you through the integration configuration and setup.
There are several ERP-specific onboarding topics that have additional onboarding steps that you must complete. After you complete an integration configuration, read Sync monitoring to learn about monitoring the health of your integration.
Create a test integration using an alternative Square account (using a different email address from your live Square account) with a non-production version of your external system environment.
Do not create an integration between your live Square account and external production system account until you have validated Square Bridge with test environments.
When integration testing is complete, create a production integration that uses the settings from your sandbox integration.
Before you start the Square Bridge signup and configuration process, complete the following steps:
Ensure that you have two Square accounts: one for production and one for testing.
Did you know?
If you want to provide access to your Square account to other members of your organization, you can use a set of credentials you are comfortable sharing or leverage Square's Full Access Team Member or Authorized Representative.
Ensure that you have two ERP accounts: one for production and one for testing. When the Square Bridge team requests it, provide access to the ERP testing system.
Ensure that you have a Google or Microsoft account available for Square Bridge. To request access, email email@example.com.
To learn how to use Square Bridge to configure and manage an integration, see Using Square Bridge.