Skip to content

Latest commit

 

History

History
33 lines (25 loc) · 3.55 KB

obtain-token-request.md

File metadata and controls

33 lines (25 loc) · 3.55 KB

Obtain Token Request

Structure

ObtainTokenRequest

Fields

Name Type Tags Description
clientId string Required The Square-issued ID of your application, which is available in the OAuth page in the
Developer Dashboard.
Constraints: Maximum Length: 191
clientSecret string | undefined Optional The Square-issued application secret for your application, which is available in the OAuth page
in the Developer Dashboard. This parameter is only required when you are not using the OAuth PKCE (Proof Key for Code Exchange) flow.
The PKCE flow requires a code_verifier instead of a client_secret.
Constraints: Minimum Length: 2, Maximum Length: 1024
code string | undefined Optional The authorization code to exchange.
This code is required if grant_type is set to authorization_code to indicate that
the application wants to exchange an authorization code for an OAuth access token.
Constraints: Maximum Length: 191
redirectUri string | undefined Optional The redirect URL assigned in the OAuth page for your application in the Developer Dashboard.
Constraints: Maximum Length: 2048
grantType string Required Specifies the method to request an OAuth access token.
Valid values are authorization_code, refresh_token, and migration_token.
Constraints: Minimum Length: 10, Maximum Length: 20
refreshToken string | undefined Optional A valid refresh token for generating a new OAuth access token.

A valid refresh token is required if grant_type is set to refresh_token
to indicate that the application wants a replacement for an expired OAuth access token.
Constraints: Minimum Length: 2, Maximum Length: 1024
migrationToken string | undefined Optional A legacy OAuth access token obtained using a Connect API version prior
to 2019-03-13. This parameter is required if grant_type is set to
migration_token to indicate that the application wants to get a replacement
OAuth access token. The response also returns a refresh token.
For more information, see Migrate to Using Refresh Tokens.
Constraints: Minimum Length: 2, Maximum Length: 1024
scopes string[] | undefined Optional A JSON list of strings representing the permissions that the application is requesting.
For example, "["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]".

The access token returned in the response is granted the permissions
that comprise the intersection between the requested list of permissions and those
that belong to the provided refresh token.
shortLived boolean | undefined Optional A Boolean indicating a request for a short-lived access token.

The short-lived access token returned in the response expires in 24 hours.
codeVerifier string | undefined Optional Must be provided when using PKCE OAuth flow. The code_verifier will be used to verify against the
code_challenge associated with the authorization_code.

Example (as JSON)

{
  "client_id": "APPLICATION_ID",
  "client_secret": "APPLICATION_SECRET",
  "code": "CODE_FROM_AUTHORIZE",
  "grant_type": "authorization_code"
}