Download OpenAPI specification:Download
This is the documentation for the Ratepay authorization server. The API uses the OAuth 2.0 protocol with JSON Web Tokens (JWT) for authentication and authorization.
Request an OAuth token from the Ratepay authorization server.
| client_id required | string Client ID provided by Ratepay. | ||||||||||||||||||||||||||||||||||||||||||||||||
| client_secret required | string Client secret provided by Ratepay. | ||||||||||||||||||||||||||||||||||||||||||||||||
| audience required | string Specific resources and scope (environment). To access the API, use the URLs defined below.
| ||||||||||||||||||||||||||||||||||||||||||||||||
| grant_type required | string The type of grant presented in the exchange. Use |
Successfully created an access token.
Invalid credentials.
{- "client_id": "your-client-id",
- "client_secret": "your-client-secret",
- "grant_type": "client_credentials"
}{- "access_token": "ey...",
- "expires_in": 1800,
- "token_type": "Bearer"
}