Prerequisites
Before you begin your integration, you must obtain your API credentials and configure your environment. Every integration requires:
-
API Keys: Generated within your Titus Dashboard.
-
Webhook Registration: Configured to receive real-time transaction updates.
1. Staging Environment
Access to the Titus Staging environment is currently gated to ensure high-quality support during development.
-
Access Request: Email support@gotitus.com to request a staging account.
-
Authentication: Once approved, the Titus team will provide a unique Phone PIN for your business to bypass standard 2FA in the test environment.
2. Production Environment
Once you are ready to go live, follow the steps below based on your integration path.
Choose your path:
|
Integration Path |
Onboarding Link |
|
Platform Integration |
|
|
Business Integration |
Important Production Requirements:
-
US Phone Numbers: You and all administrative users must have a valid US-based phone number to create and manage the account.
-
Manual Review: After setting up your account, the Titus team must review your integration. Your API keys will remain inactive until this manual review is completed and your account is toggled to "Live."
-
Business Owners (Direct Business Only): We recommend that the business owner completes the sign-up process personally to submit the necessary credit card processing applications immediately, preventing delays in activation.
3. Retrieve your API Keys
Titus uses API keys to authenticate requests. Once your account is created, you can manage your credentials within the dashboard:
-
Navigate to Settings > Keys.
-
Copy your Secret Key for server-side requests.
Security Note: Your Secret Key grants full access to your account data. Store it securely in your environment variables and never commit it to version control.
4. Register a Webhook
To receive real-time updates (such as payment confirmations or status changes), you must register a webhook endpoint.
-
In your dashboard, go to Settings > Webhooks.
-
Provide an HTTPS POST endpoint from your server.
-
Save the provided Webhook Secret. You will need this to verify that incoming requests are authentically sent from Titus.
Local Development & Testing
Since Titus needs a public URL to send webhook events, you cannot use localhost directly. We recommend using a tunneling tool like ngrok to create a secure tunnel to your local machine.
-
Step 1: Start your tunnel (e.g., ngrok http 3000).
-
Step 2: Copy the generated forwarding URL (e.g., https://random-id.ngrok-free.app/webhooks).
-
Step 3: Register this full URL in the Titus dashboard.
Integration Ready
With your API keys and webhooks configured, you are ready to begin the implementation.