- Getting Started
- Environments
Getting Started
Environments
Sandbox and Production environments, base URLs, rate limits, and best practices.
Remitian Public API provides two environments for testing and deploying your integrations:
- Sandbox Environment — Test API integration without affecting real data
- Production Environment — Deploy your code and go live
Environment Comparison
| Feature | Sandbox | Production |
|---|---|---|
| Base URL | https://public-api.sandbox.remitian.com( .ca for CA customers) | https://public-api.remitian.com( .ca for CA customers) |
| Firms Management | ✓ | ✓ |
| Taxpayers Management | ✓ | ✓ |
| Tax Payments Scheduling | ✓ | ✓ |
| Tax Form Import | ✓ (Simulated data) | ✓ |
| Webhooks | ✓ | ✓ |
| Filter Tax Entities and Taxpayers by TIN | ✓ (own key) | ✓ (own key) |
| SFTP File Delivery | ✓ | ✓ |
| Rate Limits | 200 requests per 10 minutes | 1,000 requests per minute |
| Data Requirements | Synthetic data only | Real data |
Each environment has its own TIN encryption key: a TIN encrypted with the key of another environment returns 400 Bad Request. Download the key from the Developer Portal of the environment you call.
Note: Endpoints marked with (Coming Soon) are announced ahead of release and are not yet available in any environment, including Sandbox. Their contract is preliminary and may change before release. They are added to the Postman collection when they are released to Sandbox and Production.
Base URLs by Region
Remitian runs the Public API in the United States and in Canada. Each region has its own Sandbox and Production environment. Use the base URLs of the region of your account.
| Region | Sandbox | Production |
|---|---|---|
| United States | https://public-api.sandbox.remitian.com | https://public-api.remitian.com |
| Canada | https://public-api.sandbox.remitian.ca | https://public-api.remitian.ca |
The examples in this documentation use the United States URLs.
Sandbox Environment
The Sandbox environment allows you to test your integration safely without affecting production data or processing real transactions.
Key Features
- Test Data Only: All operations use simulated data — NEVER use real customer data
- No Financial Impact: Tax payments are not actually processed
- Form Import Simulation: Test tax form import workflows with sample data
- Safe Testing: Experiment freely without risk to real taxpayer information
- Conservative Rate Limits: Lower rate limits (200 requests per 10 minutes) help you test against a more restrictive system and prepare for edge cases
- Periodic Resets: The Sandbox environment is periodically reset for security and maintenance purposes
Important: The Sandbox environment has more conservative rate limits than Production. This intentional restriction helps you build robust integrations that handle rate limiting properly and are prepared for various network conditions.
Data Persistence: The Sandbox environment is periodically reset for security reasons. Do not depend on any persisted sandbox data. All test data may be deleted without notice. Always use the Sandbox for testing purposes only and maintain your test data in your own systems if needed for reference.
When to Use Sandbox
- Initial integration development
- Testing new features or changes
- Troubleshooting and debugging
- Developer training and experimentation
Production Environment
The Production environment is for live applications processing real tax payments and managing actual taxpayer data.
Key Features
- Real Data: All operations affect live taxpayer and firm records
- Actual Payments: Tax payments are processed and submitted to tax authorities
- Full Functionality: Access to all API features and capabilities
- Higher Rate Limits: Increased request capacity for production workloads
When to Use Production
- Live applications serving real users
- Processing actual tax payments
- Managing real firm and taxpayer data
- Production-ready integrations
Best Practices
Development Workflow
- Develop in Sandbox: Build and test your integration in the Sandbox environment
- Validate Thoroughly: Ensure all features work correctly with test data
- Deploy to Production: Move to Production only after complete testing
- Monitor Usage: Track your API usage and stay within rate limits
Environment-Specific Configurations
Store environment-specific configuration separately in your application:
const config = {
sandbox: {
baseUrl: 'https://public-api.sandbox.remitian.com',
// Sandbox credentials
},
production: {
baseUrl: 'https://public-api.remitian.com',
// Production credentials
}
};
Important: Use separate credentials for each environment. Never use production credentials in development or testing.
Need Help?
Our support team is here to assist you:
- Email: support@remitian.com
- Response Time: Within 1-2 business days