Skip to main content
When integrating with the Carbon Business API, understanding the different environments available is crucial for smooth development and deployment. Carbon provides two distinct environments (Sandbox and Live) each tailored for specific stages of your integration process. This guide will walk you through the purpose of each environment, how to use them effectively, and best practices for transitioning from testing to live operations.

​
Sandbox Environment

​
What is the Sandbox Environment?

The Sandbox environment is a tailored testing ground that allows you to interact with the API without affecting live data or moving real funds. It is designed to mimic the Live environment’s functionality.

​
Why Use the Sandbox Environment?

  • Safe Testing: Experiment with API calls without financial risk.
  • Development: Integrate and debug your application freely.
  • Simulation: Replicate various transaction scenarios and server responses.

​
How to Access the Sandbox Environment

You can interact with the Sandbox environment using the following base URL: 
https://carbonapistagingsecure.getcarbon.co/baas/api
Ensure you use the API keys generated from your Sandbox Dashboard to avoid authentication issues.
  • Treat the Sandbox as a replica of your production environment.
  • Test your error handling and edge cases.
  • Frequent your dashboard to verify the state of your simulated transactions.

​
Live Environment

​
What is the Live Environment?

The Live environment is the production setup where real-world transactions take place. Connections made here interact with actual banking networks, and money movements are real and final.

​
Why Use the Live Environment?

  • Real Operations: Process genuine customer transactions and payouts.
  • Production Data: Maintain actual records of accounts and financial history.

​
How to Access the Live Environment

The Live environment URL is provided upon completing your business verification and Go-Live process. You must switch your API keys to the Live versions.
  • Security: Tightly control access to your Live API keys.
  • Monitoring: Set up logging and alerts for your API integrations.
  • Compliance: Ensure your integration adheres to all financial regulations and standards.

​
Transitioning from Sandbox to Live

1

Final Testing in Sandbox

Perform a final round of testing in the Sandbox to ensure all functionality works as intended.
2

Update Configuration

Modify your application’s configuration to point to the Live environment URL. Ensure that apikey, x-carbon-key, and environment-specific settings are updated accordingly.
3

Perform a Controlled Launch

Consider rolling out your integration gradually in Live to monitor its performance and make adjustments as needed.
4

Ongoing Monitoring

After moving to Live, continue to monitor your integration closely, particularly in the early stages of deployment.

​
Important Considerations

Remember that your API keys are environment-specific. Ensure that you are using the correct keys for each environment to avoid authentication errors.
Always store your API keys securely and follow best practices for API security, especially in the Live environment.
Keep in mind that data in the Sandbox is separate from Live. Actions in the Sandbox will not affect your live data or operations.