Build with the Mobile Authorization API to request authorization tokens to initialize Square mobile solutions like the Reader SDK.
Docs Home
Dev Essentials
Payments Commerce Customers Staff Merchants
Partnerships
Release notes

Docs

Docs Home
Dev Essentials
Payments
Commerce
Customers
Staff
Merchants
Partnerships
Release notes
Docs
Mobile Authorization API

Build with the Mobile Authorization API

Build with the Mobile Authorization API to request authorization tokens to initialize Square mobile solutions like the Reader SDK. To embed Square mobile development solutions, you must create a service to request mobile authorization codes. You should integrate this into your existing OAuth process if possible.

Link to section
Prerequisites and assumptions

To build with the Mobile Authorization API, the following must be true:

  • You are using HTTPS. HTTPS is required for all production Square API calls. HTTP calls are only supported for developing and testing on localhost.

  • You are using production credentials. The Mobile Authorization API is not supported in the Square Sandbox.

Additionally, you need the following information:

Link to section
Information you need

To use the steps in this topic, you need:

  • An active location ID. Copy a valid developer account location ID from the Production mode Locations setting page of your Square application in the Developer Dashboard.

  • A valid access token. For more information, see Access Tokens and Other Square Credentials.

Link to section
Request a mobile authorization code

Add code to use the location ID and OAuth token to request a mobile authorization code. The authorization service should return the mobile authorization code to the calling application but for the sake of this example, Square simply prints it to the screen.

Create Mobile Authorization Code
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
curl https://connect.squareupsandbox.com/mobile/authorization-code \
  -X POST \
  -H 'Square-Version: 2023-05-17' \
  -H 'Authorization: Bearer {SANDBOX_ACCESS_TOKEN}' \
  -H 'Content-Type: application/json' \
  -d '{
    "location_id": "{SANDBOX LOCATION ID}"
  }'
Try in API Explorer

Important

Mobile authorization codes are short lived and should be used immediately to authorize mobile solutions like the Reader SDK. Mobile authorization does not expire after a set amount of time. Authorization remains valid unless it is explicitly revoked (for example, by calling deauthorize in the Reader SDK) or the authorized application fails to take a payment within 90 days.

On this page
We've made improvements to our docs.
Prefer the old format?