Authentication

All endpoints require authentication via an API Key.

API Key Header

This method is recommended for secure server-to-server communication where API keys can be securely stored as environment variables.

HTTP
X-API-KEY: ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
  • Use ak_live_ prefixed keys for production transactions.
  • Keys are provisioned automatically when you upgrade to developer.

Note: Never expose your API keys in client-side code like React or plain HTML.


Regenerating Keys

If you believe your key has been compromised, you can easily rotate it.

JSON
POST /keys/regenerate/
{
  "mode": "live"
}

Warning: Once regenerated, the old key is immediately deactivated. Update your integration environment variables immediately before regenerating to prevent downtime.