ObtainTokenRequest
April 25, 2020 ยท View on GitHub
Description
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| client_id | getClientId() | setClientId($value) | string | The Square-issued ID of your application, available from the application dashboard. | |
| client_secret | getClientSecret() | setClientSecret($value) | string | The Square-issued application secret for your application, available from the application dashboard. | |
| code | getCode() | setCode($value) | string | The 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] |
| redirect_uri | getRedirectUri() | setRedirectUri($value) | string | The redirect URL assigned in the application dashboard. | [optional] |
| grant_type | getGrantType() | setGrantType($value) | string | Specifies the method to request an OAuth access token. Valid values are: `authorization_code`, `refresh_token`, and `migration_token` | |
| refresh_token | getRefreshToken() | setRefreshToken($value) | string | 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 the application wants a replacement for an expired OAuth access token. | [optional] |
| migration_token | getMigrationToken() | setMigrationToken($value) | string | 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. | [optional] |
Note: All properties are protected and only accessed via getters and setters.