Documentation Index
Fetch the complete documentation index at: https://docs.hyperrail.io/llms.txt
Use this file to discover all available pages before exploring further.
Test Mode Overview
HyperRail gives you a test environment—called test mode—where you can build and verify your integration without touching real money or live accounts. Everything works the same way as production: the same API endpoints, the same dashboard, the same transaction flows. The only difference is that nothing is real. No actual funds move, no real bank accounts are involved, and no live payment networks are contacted.Test Mode vs. Live Mode
| Test Mode | Live Mode | |
|---|---|---|
| API keys | Start with sk_test_ | Start with sk_live_ |
| Money movement | Simulated | Real |
| Bank details | Any value works | Must be valid |
| Balances | Funded via simulator | Funded via real transfer |
| Webhooks | Triggered normally | Triggered normally |
| Dashboard | Separate test view | Live view |
What You Can Do in Test Mode
- Fund accounts using the Funding Simulator
- Create and accept quotes
- Simulate on-ramp, off-ramp, and fiat exchange flows
- Trigger and receive webhook events
- Test payout flows without sending real money
What Test Mode Does Not Support
- Real fund transfers to or from bank accounts
- Live FX rates (rates in test mode are simulated)
- Production KYB or compliance checks
How to Know You Are in Test Mode
Check your dashboard header—it will show a Test Mode indicator when you are in the sandbox environment. Your API keys will also begin withsk_test_ instead of sk_live_.
If you are making API calls, always confirm you are using your test key before running any transaction flow.
Switching Between Test and Live
You can toggle between test and live mode directly from your HyperRail dashboard. The toggle is in the top navigation bar.Switching modes does not affect your live data. Test transactions, balances, and accounts are completely separate from your live environment.
Where to Start
If this is your first time in test mode, the recommended order is:- Fund a test account using the Funding Simulator
- Make a test transaction using your test API keys
- Verify webhooks are being received correctly on your endpoint
- Review the results on your test dashboard