The OAuth Client Credentials API retrieves an OAuth access token. This access token must be included in the Authorization Bearer HTTP header for subsequent LynkUp API requests.
- The API utilizes BASIC authentication. Your clientId must be provided as the username and your clientSecret as the password.
- The OAuth API should only be called once in a given period of time. The access token can be reused many times for subsequent API calls.
- The access token expiration time is returned in the "expires_in" field of the response. The token should be cached and reused until slightly prior to the expiration time.
- If the access token expires, a new token must be requested using the same credentials. The old token will no longer be valid.
Create Token
SecurityBasicAuth
Request
Responses
200
successful operation
400
Invalid Request
401
Unauthorized Request
403
Blocked Merchant
429
Quota Limit Exceeded
post/ent-services/security/v1/oauth/token
Request samples
- Payload
- curl
- Node.js
- JavaScript
- PHP
- Python
- C#
- Java
application/x-www-form-urlencoded
grant_type=client_credentialsResponse samples
- 200
- 400
- 401
- 403
- 429
application/json
{- "token_type": "string",
- "issued_at": "string",
- "client_id": "string",
- "access_token": "string",
- "scope": "string",
- "expires_in": "string",
- "refresh_count": "string",
- "status": "string"
}