Skip to content
Status

Connecting Square

Connecting to Square is an OAuth process. It requires you to log into Square, which then shares a security token with us. To complete this you need a Square login.

  1. When prompted, select Connect Square to log in to your Square account.

    Connect Square dialog

  2. You will be prompted with a login screen. Log in to your Square account.

    Square sign-in screen

  3. You will be prompted to grant access for “Payments” to submit payments on your behalf. Select Allow.

  4. When you are returned to the app, the connection is tested and you are shown a green “Connected to Square” message. If there is an error with the connection, use the Reconnect button — but take care to connect to the same account, otherwise saved payment methods and refunds will return an error message.

    Connected to Square confirmation screen

Our integration with Square offers several options:

  • Location: Select the location you want payments taken against. You can check your locations in Account → Locations → Production.

    Square Developer portal Locations page

  • Enable ACH: Enables ACH as a payment method. You must also enable this option on Square. Shown only when your Square account takes USD.

  • Enable order creation for all payments: Creates a Square order for every payment, so payments appear against an order in Square. Without it, an order is created only when the payment includes line items.

  • Use Square Risk Manager for 3D Secure: Lets the 3D Secure rules in Square Risk Manager decide when to authenticate a card payment. Only turn this on once you have created a Require 3D Secure rule in your Square Dashboard. With it off, the integration requests 3D Secure verification on every card payment the customer makes online (MOTO payments taken over the phone are excluded).

  • Skip receipt on POS: Skips the receipt screen on the Square point-of-sale app. Shown only where Square terminal (point of sale) acceptance is enabled; that is a platform-level setting, not a per-connection option.

Users connecting to Square in a sandbox environment will see the following error message, as they have a slightly different process.

Sandbox OAuth error message

To connect a sandbox account:

  1. Log into the Square Developer portal: developer.squareup.com.

  2. Select (or create) a Sandbox test account via Account → Sandbox Test Accounts → + New sandbox test account.

    Square Developer portal Sandbox test accounts page

  3. Select Square Dashboard for the account you want to connect to. You must do this in the same browser that you will use to connect to Square, as this process drops a cookie on your browser.

  4. Go through the OAuth process. You will not be required to sign in to Square again.

Was this page helpful?