GetOAuthAccessToken
Gets an authentication token from Square.
Input
| Name | Type | Required | Description |
| AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app.
The allowed values are APP, WEB. The default value is APP. |
| Permissions | String | False | A comma-separated list of permissions to request from the user. Please check the Square API 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. |
| CallbackUrl | String | False | The URL the user will be redirected to after authorizing your application. This value must match the Redirect URL you have specified in the Square app settings. Only needed when the Authmode parameter is Web. |
| Verifier | String | False | The verifier returned from Square after the user has authorized your app to have access to their data. This value will be returned as a parameter to the callback URL. |
| State | String | False | Indicates any state which may 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 |
| OAuthAccessToken | String | The access token used for communication with Square. |
| OAuthRefreshToken | String | The OAuth refresh token. |
| ExpiresIn | String | The remaining lifetime on the access token. A -1 denotes that it will not expire. |
| MerchantID | String | The merchant account this access token is associated with. |