Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.fype.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication & API Keys

Fype uses API keys to authenticate requests. You can manage your API keys in the Fype Dashboard.

​
Key Types

Fype provides two environments for every merchant account: Test and Live.
Key PrefixEnvironmentPurpose
fype_test_TestDevelopment and testing using the Fype Simulator. No real money is moved.
fype_live_LiveProduction use with real payment gateways and real money.

​
Authenticating Requests

All API requests must include your secret API key in the Authorization HTTP header as a Bearer token. 
Authorization: Bearer fype_test_your_secret_key
Warning: Your secret API keys carry significant privileges. Keep them secure! Do not share them in publicly accessible areas such as GitHub, client-side code, or browsers.

​
Obtaining API Keys

  1. Sign up or log in to the Fype Dashboard.
  2. Go to Developers > API Keys.
  3. Toggle between Test and Live modes in the dashboard sidebar.
  4. Click Create Key to generate a new key for the selected environment.
  5. Copy the key immediately. For security reasons, the full key is only shown once.

​
Key Rotation

If an API key is compromised, you should revoke it immediately:
  1. Go to the API Keys section in the dashboard.
  2. Find the key you wish to revoke.
  3. Click the Delete (Trash) icon.
  4. Once revoked, the key can no longer be used to authenticate requests.
  5. Generate a new key and update your application settings.

​
Environment Isolation

  • Data created in Test mode is completely isolated from Live mode.
  • Payments created with a fype_test_ key will only be visible in the Test dashboard and will only trigger Test webhooks.
  • You must configure separate Webhook Endpoints for Test and Live environments.