Use Sandbox Mode
1
Enable Sandbox Mode
Toggle Sandbox Mode in the user menu of the Dashboard.
2
Use test API keys
Generate your test API key under Developer → Secrets and use it against the sandbox base URL (see Introduction). Register your webhook endpoint under Developer → Webhooks.
3
Simulate activity
Simulate a deposit under Payments → Deposits → + Create deposit: pick the account, amount, reference, and rail (ACH, Fedwire, or SWIFT). The deposit settles within seconds and shows up under Transactions.
4
Go live
Once your account is activated, switch off Sandbox Mode and generate live API keys.
The Sandbox Mode toggle in the Dashboard does not affect your integration. Your API keys and base URL determine which mode you’re in.
What you can do from the Dashboard
Every sandbox action has a Dashboard control or an API endpoint. The API walkthrough is Simulations; this table maps each step to its Dashboard equivalent.Test a payout
1
Create a payout
Via the API against a saved counterparty (see Payouts), or in the Dashboard under Payments → Payouts → + Create payout to a whitelisted destination. The payout starts as
initiated and moves to submitted once the sandbox rail acknowledges it.2
Open Sandbox Tools
Open the payout in its detail view under Payments → Payouts.
3
Set the outcome
Choose Simulate payout → succeeded (the payout becomes
sent), failed (the payout becomes failed with a failure reason), or returned (the payout becomes returned and the amount is credited back to your account). Verify status and webhooks.Test a return
1
Initiate a return
Return a deposit you received with POST
/v1/returns, or from the deposit’s detail view in the Dashboard. The deposit stays settled; the return is a linked resource with the payout statuses minus submitted (initiated, sent, failed, returned).2
Follow the return
The deposits list shows the return’s status next to the deposit, and the detail view lists it with its ID. A new return stays
initiated until you drive it, the same way as a payout. Sandbox Tools on the deposit (or the return simulation endpoints) make it sent, let it fail (failed), or play the sender’s bank sending it back, so it becomes returned with the funds credited to your account again.Production
Switch to live API keys and start with small amounts.What’s next
- End-to-end API walkthrough: Simulations drives the same flows with the
/v1/simulations/*endpoints instead of the Dashboard. - Sandbox base URLs: 2026-05-01 / 2023-01-01.
- Webhooks: 2026-05-01 / 2023-01-01.