Excel Add-In for Square

Build 26.0.9770

GetOAuthAuthorizationURL

Retrieves the authorization URL used to grant access to your application. The user must open this URL separately to complete authorization and obtain the OAuthAccessToken. Only required when developing web applications.

Input

Name Type Required Description
CallbackUrl String False The URL the user is redirected to after authorizing your application. This value must match the Redirect URL in the Square application settings.
Scope String False A comma-separated list of permissions to request from the user. See the Square API documentation for a list of available permissions.

The default value is ITEMS_READ ITEMS_WRITE PAYMENTS_READ PAYMENTS_WRITE MERCHANT_PROFILE_READ BANK_ACCOUNTS_READ EMPLOYEES_READ CUSTOMERS_READ CUSTOMERS_WRITE SETTLEMENTS_READ INVENTORY_READ INVENTORY_WRITE ORDERS_READ TIMECARDS_READ TIMECARDS_WRITE DEVICES_READ DEVICE_CREDENTIAL_MANAGEMENT ONLINE_STORE_SITE_READ INVOICES_WRITE INVOICES_READ ORDERS_WRITE SUBSCRIPTIONS_READ SUBSCRIPTIONS_WRITE GIFTCARDS_READ GIFTCARDS_WRITE APPOINTMENTS_READ APPOINTMENTS_WRITE APPOINTMENTS_BUSINESS_SETTINGS_READ APPOINTMENTS_ALL_WRITE MERCHANT_PROFILE_WRITE EMPLOYEES_WRITE PAYMENTS_WRITE VENDOR_READ VENDOR_WRITE.

State String False Indicates any state which might be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Square authorization server and back. Uses include redirecting the user to the correct resource in your site, nonces, and cross-site-request-forgery mitigations.

Result Set Columns

Name Type Description
URL String The authorization URL, entered into a Web browser to obtain the verifier token and authorize your application.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770