Authentication

Create Bearer token

Request a Bearer token that will be used as an access token when making calls to resources. The credentials need to be sent within the body of the request.

post/auth/oauth/v2/token

Request

Base URL
https://api.paychex.com
Auth
none declared
TypeScript
https://skmtc.dev/paychex/apis/external-api/docs/auth/oauth/v2/token/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body application/x-www-form-urlencoded

grant_typestring required

Send "client_credentials".

client_idstring required

The applications API key.

client_secretstring required

The applications corresponding secret.

Response

successful operation

access_tokenstring

The token which will be used for making future calls.

expires_instring

Number of seconds remaining before the token expires.

scopestring

This will always return 'oob' (out of band) based on OAuth configuration.

token_typestring

This will always return 'Bearer' based on OAuth configuration.

Example response

{
  "access_token": "99f9c30a-8134-4a30-a789-7c7665add41e",
  "scope": "oob",
  "token_type": "Bearer"
}

Changes

No recorded changes to this operation across all 1 revision of this API.