Banqup provides a customer validation environment (CVE): a sandbox with its own, separate data. Use it to build and test an API integration, or to try out features in the mobile app, without touching the invoices, payments and contacts in your live space.
What the sandbox environment is
Separate data. Nothing you create in the sandbox appears in your live Banqup space, and nothing you do there changes your live data.
Same features. The sandbox runs the same Banqup platform and the same API as production, so what works in the sandbox works in your live space.
Three entry points.
Web app: app.cve.btx.banqup.com
Developer Portal, where developers create their app and API credentials: dev.cve.btx.banqup.com
Developer documentation for the sandbox: docs.cve.btx.banqup.com
Testing an API integration in the sandbox
Start from the Getting started guide in the sandbox documentation. It explains which authentication flow your integration needs.
Your developer creates the app and its client credentials on the sandbox Developer Portal. Credentials are specific to one environment: sandbox credentials do not work in production, and production credentials do not work in the sandbox.
Point the integration at the sandbox API. The base URLs are listed in the API guides.
In the sandbox web app, the space administrator grants the app access to the space, exactly as described in Managing external application permissions.
Run your tests. Sales invoices, purchase invoices and other documents you create stay in the sandbox.
When the integration works as expected, repeat steps 2 and 4 in production, using the production documentation and the production Developer Portal.
Using the sandbox in the Banqup One mobile app
You do not need a separate app for the sandbox. The Banqup One app you already use can switch to the sandbox from its settings.
Open the Banqup One app and log in as usual.
Tap your profile, then tap Settings.
Tap Other preferences.
Turn on Sandbox mode.
In the confirmation dialog, tap Turn on sandbox mode.
The app switches to the sandbox and shows sandbox data only. Your live data is not changed and stays available when you switch back.
To return to your live data, follow the same path and tap Turn off sandbox mode. The test data you created stays in the sandbox for the next time you switch.
FAQ
Does anything I do in the sandbox affect my live Banqup space?
No. The sandbox has its own data. Documents, contacts and settings you create there never appear in your live space.
Can I use my live credentials in the sandbox?
No. Apps, client credentials and space permissions are set up per environment. Create them in the sandbox Developer Portal for testing and again in the production Developer Portal when you go live.
Where do I find the sandbox API documentation?
At docs.cve.btx.banqup.com. It has the same guides, recipes and API explorer as the production documentation.
I switched the mobile app to sandbox mode and my invoices are gone. What happened?
Nothing is lost. The app is showing the sandbox, which is empty until you add test data. Turn off Sandbox mode under Settings > Other preferences to see your live data again.