ObtainTokenRequest

September 24, 2019 ยท View on GitHub

Description

Properties

NameTypeDescriptionNotes
clientIdStringThe Square-issued ID of your application, available from the application dashboard.
clientSecretStringThe Square-issued application secret for your application, available from the application dashboard.
codeStringThe authorization code to exchange. This 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.[optional]
redirectUriStringThe redirect URL assigned in the application dashboard.[optional]
grantTypeStringSpecifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token`
refreshTokenStringA 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 the application wants a replacement for an expired OAuth access token.[optional]
migrationTokenStringLegacy 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.[optional]