​
Sandbox Configuration and Activation

This guide explains how to set up and activate your FinHub sandbox environment, allowing you to test and develop your integration before moving to production.

​
Sandbox Overview

The FinHub sandbox is a fully functional testing environment that mimics the production environment. It allows you to:
  • Test API integrations without affecting real data or transactions
  • Explore API capabilities and features
  • Develop and debug your integration
  • Validate your implementation against FinHub requirements

​
Prerequisites

Before configuring your sandbox, ensure you have:
  1. Completed the registration process as a FinHub API client
  2. Received your sandbox tenant credentials via email
  3. Access to the FinHub Developer Portal

​
Sandbox Configuration Steps

​
1. Access the Developer Portal

Log in to the FinHub Developer Portal using the credentials provided during registration.

​
2. Create a Sandbox Tenant

  1. Navigate to the “Sandbox” section in the Developer Portal
  2. Click “Create New Sandbox Tenant”
  3. Fill in the required information:
    • Tenant name
    • Technical contact information
    • Selected products for testing
  4. Submit the form to create your sandbox tenant

​
3. Configure API Access

  1. Once your sandbox tenant is created, navigate to the “API Access” section
  2. Generate your client credentials:
    • Client ID
    • Client Secret
  3. Note down these credentials as they will be required for authentication

​
4. Configure IP Whitelisting

For security reasons, you need to whitelist the IP addresses that will access the FinHub APIs:
  1. Go to the “Security” section
  2. Add the IP addresses of your development and testing environments
  3. Save your changes

​
5. Configure Webhook Endpoints (Optional)

If your integration requires webhooks:
  1. Navigate to the “Webhooks” section
  2. Add the URLs where FinHub should send event notifications
  3. Configure the events you want to receive

​
6. Activate Your Sandbox

After completing the configuration:
  1. Go to the “Activation” section
  2. Review your configuration
  3. Click “Activate Sandbox”
  4. Confirm the activation
Your sandbox will be activated within 15 minutes, and you’ll receive a confirmation email.

​
Sandbox Limitations

While the sandbox environment closely resembles the production environment, there are some limitations:
  • Transaction limits are set to lower values
  • Some features may have simulated behavior
  • External integrations (like card networks) use test environments
  • Response times may differ from production

​
Testing Your Sandbox Configuration

To verify your sandbox is properly configured:
  1. Try authenticating using the Sandbox Login API
  2. Test a simple API call, such as retrieving available products
  3. Check the response for expected data

​
Sandbox Support

If you encounter any issues with your sandbox configuration:

​
Next Steps