As part of a URL sent to a seller to authorize permissions for the developer, Authorize displays an authorization page and a list of requested permissions.
Authorize
Open in API Reference
The Square-issued ID for your application, which is available on the OAuth page for your application in the Developer Dashboard.
A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field’s value.
''
A space-separated list of the permissions that the application is requesting. Default: "MERCHANT_PROFILE_READ PAYMENTS_READ SETTLEMENTS_READ BANK_ACCOUNTS_READ"
MERCHANT_PROFILE_READ PAYMENTS_READ SETTLEMENTS_READ BANK_ACCOUNTS_READ
The locale to present the permission request form in. Square detects the appropriate locale automatically. Only provide this value if the application can definitively determine the preferred locale.
Currently supported values: en-IE, en-US, en-CA, es-US, fr-CA, and ja-JP.
en-IE
en-US
en-CA
es-US
fr-CA
ja-JP
If false, the user must log in to their Square account to view the Permission Request form, even if they already have a valid user session. This value has no effect in the Square Sandbox. Default: true
false
true
When provided, state is passed to the configured redirect URL after the Permission Request form is submitted. You can include state and verify its value to help protect against cross-site request forgery.
state
When provided, the OAuth flow uses PKCE to authorize. The code_challenge will be associated with the authorization_code and a code_verifier will need to passed in to obtain the access token.
code_challenge
code_verifier