Get OAuth authorize URL
GET/api/square/instances/:squareIntegrationInstance/oauth/authorize-url
Builds the Square OAuth authorization URL for this instance. Redirect the merchant's browser to the returned authorization_url; after they approve, Square redirects back and the connection is stored automatically with the granted scopes.
The requested scope set always includes the standard sales-channel read scopes plus any scopes the instance was already granted (Square replaces the grant with exactly what is requested, so re-authorizing never narrows an existing grant).
Pass capabilities=payments to additionally request PAYMENTS_READ/PAYMENTS_WRITE so the account can process register card payments. Use the same parameter to widen an existing channel-only connection (incremental re-consent).
When payment scopes are granted, payments_enabled is set on the instance automatically.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.