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.

Developer Portal Guide

The Fype Developer Portal is your mission control for managing payments orchestration. This guide covers how to use its features to build, test, and monitor your integration.

1. Environment Management

Fype provides two entirely separate environments: Test and Live.
  • Use the Mode Toggle in the sidebar to switch between them.
  • Test Mode: For development and using the Fype Simulator.
  • Live Mode: For production transactions with real payment providers.
  • Note: API Keys, Provider Connections, and Webhook Endpoints are environment-specific.

2. API Key Management

Located under Developers > API Keys.
  • Generate Key: Creates a unique fype_test_ or fype_live_ secret key.
  • Raw Key Visibility: The secret key is shown only once. Copy and store it in a secure vault or environment variable immediately.
  • Key Prefixing: Keys are prefixed with their environment and a short unique identifier (e.g., fype_test_abc123_...) to help you identify which key is being used in logs.
  • Revocation: If a key is leaked, click the Trash icon. The key will be invalidated instantly.

3. Webhook Orchestration

Located under Developers > Webhooks.
  • Endpoints: Add the URL of your backend listener. You can add up to 5 endpoints per environment.
  • Signing Secret: Each endpoint has a unique whsec_ secret. Use this to verify Fype signatures in your code.
  • Delivery Logs: Click on an endpoint to see its history. You can view:
    • Attempt Number: Shows how many times Fype tried to send the webhook.
    • Status Code: The HTTP response code returned by your server.
    • Response Body: The first 1KB of your server’s response (useful for debugging 500 errors).
    • Event Link: A direct link to the canonical payment event that triggered the webhook.
  • Trigger Test: Use this button to send a simulated payment.succeeded event to your URL without creating a real payment.

4. Payment Monitoring & Auditing

Located under the Payments tab.
  • Search & Filter: Find payments by Fype ID, Reference ID, Customer Email, or Status.
  • Payment Lifecycle: Click any payment to see its “Event Timeline”:
    • payment.created: When the intent was registered.
    • payment.processing: When the customer opened the checkout.
    • payment.succeeded: When the gateway confirmed capture.
  • Metadata View: View the custom JSON metadata you sent during payment creation.
  • Provider Response: View the raw, redacted JSON response from the underlying gateway (e.g., Razorpay) for deep debugging.

5. Provider Connections

Located under Providers.
  • Manage your credentials for Razorpay.
  • View connection status and “Last Validated” timestamp.
  • Credential Rotation: To update your Razorpay secret, simply edit the connection and save. Fype will use the new secret for all new checkout sessions.

6. Team & Account Settings

Located under Settings.
  • Merchant Profile: Update your business name (displayed on the checkout page) and contact email.
  • Security: Change your dashboard password or enable Multi-Factor Authentication (MFA).