Skip to main content

​
Overview

The CashQ API provides two separate environments to support your development and production needs:
  • Sandbox: For testing and development
  • Production: For live transactions

​
Environment Details

EnvironmentBase URLPurposeCredentials
Sandboxhttps://api.cashqbot.com/Testing and developmentRequest via form
ProductionProvided by supportLive transactionsContact support

​
Sandbox Environment

The sandbox environment is a complete testing environment that mirrors the production API. Use it to:
  • Develop and test your integration
  • Experiment with API features
  • Test error handling
  • Validate your implementation before going live

​
Getting Sandbox Access

1

Request credentials

Fill out the Sandbox Request Form
2

Receive API key

You’ll receive your sandbox API key via email within 24 hours
3

Start testing

Use the sandbox base URL: https://api.cashqbot.com/

​
Sandbox Characteristics

Isolated Data

Data in sandbox is completely separate from production and won’t affect live transactions.

Test Safely

Test all scenarios including errors and edge cases without risk.

Same Features

Sandbox mirrors production functionality for accurate testing.

No Real Money

All transactions in sandbox are simulated - no actual money moves.

​
Production Environment

The production environment is for live transactions with real money transfers.

​
Going Live

1

Complete sandbox testing

Thoroughly test your integration in the sandbox environment
2

Request production access

Contact [email protected] to request production credentials
3

Receive credentials

Our team will provide your production API key and base URL
4

Deploy

Update your application to use production credentials and go live
Production Environment Considerations
  • All transactions involve real money
  • Errors can affect actual customer transfers
  • Ensure thorough testing in sandbox before going live
  • Monitor your production integration closely
  • Have error handling and logging in place

​
Key Differences

​
Data Isolation

  • Sandbox
  • Production
  • Test data only
  • Can be reset or modified freely
  • No impact on production
  • Safe for experimentation

​
Credentials

Each environment requires its own API key: 
# Sandbox
curl -X GET 'https://api.cashqbot.com/api/agent_balance' \
  -H 'API-KEY: sandbox_api_key_here'

# Production
curl -X GET 'https://production.url/api/agent_balance' \
  -H 'API-KEY: production_api_key_here'
Important: Data cannot be transferred between environments. You must manage data separately in each environment.

​
Best Practices

​
Development Workflow

1

Start in sandbox

Begin all development and testing in the sandbox environment
2

Test thoroughly

Test all features, error cases, and edge scenarios
3

Validate integration

Ensure your integration handles all API responses correctly
4

Move to production

Only deploy to production after complete sandbox validation

​
Configuration Management

Store environment-specific configuration separately: 
// config.js
const config = {
  sandbox: {
    baseURL: 'https://api.cashqbot.com/',
    apiKey: process.env.CASHQ_SANDBOX_API_KEY
  },
  production: {
    baseURL: process.env.CASHQ_PRODUCTION_BASE_URL,
    apiKey: process.env.CASHQ_PRODUCTION_API_KEY
  }
};

const environment = process.env.NODE_ENV || 'sandbox';
module.exports = config[environment];

​
Testing Checklist

Before moving to production, verify:
  • All API endpoints work as expected
  • Error handling is implemented
  • Edge cases are handled properly
  • Logging and monitoring are in place
  • Security best practices are followed
  • API keys are stored securely
  • Timeout and retry logic is implemented

​
Need Help?

Contact Support

Questions about environments or ready for production? Contact our support team.