Authenticate
home
Use the Authenticate API to create login sessions for Payworks API access.
API Information
Authenticate
- Version: v1
- API Base path: /api
- Protocol: HTTPS
Description
The Payworks Authenticate API is available to:
- POST a login for basic authentication using username and password used to login to web UI.
- POST to /logout in order to securely close your current session.
- POST to acquire your OAuth 2.0 authentication token using your Payworks created clientId and secret (NOTE: Functionality not currently enabled).
- POST to /auth in order to create an OAuth 2.0 session using your client application clientId, secret, and customerNumber.
The login sessions are what will be used for all other Payworks API calls.
Change Log
| Version | Endpoint | Description of Change | Date |
|---|---|---|---|
| 1.1 | auth | Enables OAuth style login with your client application | 03-18-2025 |