Setup Square

Before you can access data from users using Square, you need to follow the next steps in Square and in the Railz Dashboard.

You'll need to:

  1. Create your Square app.
  2. Add your secure keys to Railz.

Create your Square App

To create and configure an app in Square, follow the next steps:

  1. Log in to the Square Developer using your Square account credentials.
  2. Click on the Account on the top right of the page and choose Developer Dashboard.
1957

Square developer account home page. Click to Expand.

  1. Click on the + (plus) symbol or Create your first application.
  2. Enter the Application name and click Save.
  3. On the Application page, click Open in the application you just have created.
  4. Use the Sandbox and Production toggles to select which environment to configure the application in. Select the environment you want to configure.
Environment Selection. Click to Expand

Environment selection in Square developer portal. Click to Expand

  1. In the left sidebar navigation menu, click OAuth.
  2. On the OAuth page, enter the following URL into the Production Redirect URL or Sandbox Redirect URL box: https://auth.railz.ai/square. Click Save.
  3. You will see your Production Application ID / Production Application Secret or Sandbox Application ID / Sandbox Application Secret on the OAuth page. Keep this page open, you'll need these for the next steps of the process.

📘

We recommend you start testing Square in Sandbox, so you can retrieve and check sample data before going live with your application.

Add your secure keys to Railz

  1. Open the Railz Dashboard™ and log in.
  2. In the left sidebar navigation menu, go to Integrations > Commerce.
  3. Scroll down to the Square integration and click Configure.
Railz Manage Commerce Integration. Click to Expand.

Commerce integrations page in Railz Dashboard. Click to Expand.

  1. Paste in your Client ID and Client Secret from the above steps, and then click Save & Enable.
    1. For Client ID, enter the Production Application ID or Sandbox Application ID from your Square app.
    2. For Client Secret, enter the Production Application Secret or Sandbox Application Secret from your Square app.
Railz Manage Commerce Integration. Click to Expand.

Configure the Square integration modal. Click to Expand.