Skip to main content
All requests to the HIFI API must be authenticated using API keys. This guide covers how to create, secure, and manage your keys.

​
Prerequisites

To get your API keys, you’ll need access to the HIFI Dashboard. Don’t have access? Schedule a call with our team.

Request access

Describe your use case and schedule an intro call

​
API Environments

HIFI provides two environments for development and production:
EnvironmentBase URLPurpose
Sandboxhttps://sandbox.hifibridge.comTesting and development with simulated transactions
Productionhttps://production.hifibridge.comLive transactions with real money movement

​
Creating API Keys

​
Access the API Keys Section

  1. Log in to the HIFI Dashboard
  2. Navigate to Developer → API Keys
    Or go directly to: dashboard.hifibridge.com/developer/apiKeys

​
Select Your Environment

Choose which environment you’re creating keys for:
  • Sandbox - For testing and development
  • Production - For live operations
Best Practice: Start with sandbox keys to build and test your integration before moving to production.

​
Generate a New API Key

  1. Click the “Create API Key” or “New API Key” button
  2. Provide a descriptive name that identifies the key’s purpose
    Examples:
    • “Production Web App”
    • “Staging Server”
    • “Mobile App Development”
    • “Webhook Service”
  3. Click “Generate” to create the key

​
Copy and Secure Your API Key

API keys are shown only once at creation. If you lose your key, you’ll need to generate a new one and update your application.
After generation:
  1. ✅ Immediately copy the API key from the dashboard
  2. ✅ Store it securely in your environment variables or secrets manager
  3. ✅ Never commit keys to version control (Git, SVN, etc.)
  4. ✅ Never expose keys in client-side code or public repositories
Example of secure storage: 
# .env file (add to .gitignore)
HIFI_API_KEY=zpka_1234567890abcdef
HIFI_ENVIRONMENT=sandbox

​
Managing API Keys

​
Deleting API Keys

If a key is compromised or no longer needed:
  1. Navigate to Developer → API Keys in the dashboard
  2. Find the key you want to delete
  3. Click “Delete” or the delete icon
  4. Confirm the deletion
Deleted keys stop working immediately. Ensure you’ve updated your application with a new key before deleting the old one.

​
Testing Your API Key

Verify your API key is working correctly with the ping endpoint: 
curl -X GET "https://sandbox.hifibridge.com/v2/ping" \
  -H "Authorization: Bearer YOUR_API_KEY"
Successful response: 
{
  "message": "pong"
}
Authentication error: 
{
  "error": "Not authorized"
}

​
Next Steps

Now that you have your API keys set up:

​
Getting Help

Having trouble with authentication?
  1. ✅ Verify your API key is active in the dashboard
  2. ✅ Check the header format: Authorization: Bearer YOUR_KEY
  3. ✅ Ensure you’re using the correct environment endpoint
Still need help?