API Reference

API Keys Configuration Guide

API keys are used to authenticate your API requests to Paystrator.
Each API key can have specific permissions per product, ensuring secure and controlled access.

❗️

Treat your API keys like passwords β€” never share them publicly or embed them in client-side code.


πŸ“Œ Where to Find API Keys Configuration Settings

  1. In your Paystrator dashboard, go to:
    Settings β†’ Developers
  2. You’ll see three tabs:
  • API Keys ← (this one)
  • IP Whitelist
  • Webhooks
πŸ“˜

If you are in Testing mode, you can skip this stage β€” a default API key has already been generated for you.


How to Create a New API Key

  1. Click + Create New API Key.
  2. Enter a Key Name (e.g., Backend Integration or Mobile App).
  3. For each product, set the capabilities:
    1. None – No access
    2. Read Only – Can retrieve data but not modify it
    3. Write Only – Can send data but not retrieve it
    4. Read & Write – Full access to that product
  4. Click Save & Close.
  5. Copy your API key and store it securely β€” this is the only time you will be able to see the full value.

πŸ’‘ Tips & Best Practices

  • Use separate keys for development, staging, and production environments.
  • Rotate keys periodically or immediately if you suspect compromise.
  • Limit permissions to the minimum required for each use case.
  • Store keys securely in environment variables or a secrets manager.
  • Never commit keys to source control or expose them in client-side code.

▢️ Next Step

With your API key ready, proceed to:

IP Whitelist Configuration Guide