Skip to main content
API keys authenticate requests to Paygentic. Each key belongs to a specific user and inherits that user’s permissions.

​
Key format

Keys are environment-specific: Sandbox keys only work with sandbox endpoints. Live keys only work with production endpoints.

​
Creating keys

  1. Log in to the Paygentic Dashboard
  2. Navigate to More → Developer → API Keys
  3. Select Create New Key
  4. Name the key descriptively
  5. Copy immediately - it won’t be shown again
Store keys securely. Use environment variables or secret managers, never commit to version control.

​
Managing keys

Viewing keys
  • See all active keys
  • Check creation and last-used dates
  • Identify by descriptive names
  • View partial values (last 4 characters)
Revoking keys Navigate to More → Developer → API Keys, find the key, and select Revoke. Revocation is immediate — applications using that key will fail authentication.

​
Usage

Include keys in the Authorization header using Bearer authentication scheme.

​
Security practices

Mandatory
  • Never commit keys to git
  • Use environment variables
  • Rotate keys regularly
  • Revoke compromised keys immediately
  • Use sandbox keys for development only
Recommended
  • Separate keys per application
  • Monitor usage to find inactive keys
  • Document which applications use which keys
  • Use descriptive key names

​
Troubleshooting

Authentication failures
  • Verify correct key format
  • Check key hasn’t been revoked
  • Confirm environment match (test vs live)
  • Use correct base URL for environment
Permission errors
  • Verify user permissions for the key
  • Check organization context
  • Contact admin for permission changes