The Sandbox API
Our test environment where you can safely play around with our APIs and Client Portal
The Sandbox environment provides a safe space to develop and test your API integration without affecting real transactions or funds. It includes a payment simulator that lets you test various payment flows and scenarios before moving to production.
Feature Parity with Production
While we strive to maintain feature parity between Sandbox and Production environments, there are some key differences to be aware of:
- Payment processing is simulated rather than connecting to actual payment schemes or clearing houses
- While most endpoints work in Sandbox, some options may not be available
For detailed information about which endpoints and features are available in the Sandbox environment, please refer to the API reference documentation. Each endpoint's documentation includes specific notes about Sandbox compatibility and any differences in behavior compared to production.
Sandbox-Specific Endpoints
While the Sandbox environment mirrors production behavior through shared endpoints, it also provides specialized testing endpoints that enable you to:
- Generate notifications independently of payment events
- Create simulated incoming payment scenarios
- Simulate outgoing payments directly, bypassing the normal initiation flow while maintaining full payment lifecycle events (e.g. notifications, bookings, reporting)
These sandbox-specific endpoints help you test edge cases and specific scenarios that might be difficult to reproduce in production.
Limitations
- No real-time connection to payment schemes or clearing houses
- Simulated processing times may not match actual production timelines
- Test data is periodically reset
- Limited historical data availability
- Some advanced payment features may have simplified behavior
- Sandbox performance characteristics may differ from production
- Occasional scheduled maintenance windows may result in temporary service unavailability
Updated 3 months ago
Read the other articles in this section to better understand how the Sandbox works, how to test various scenarios and what limitation you need to be aware of.