API

What is Test Mode?

Using Test Mode to safely test API integrations without real money

What is Test Mode?

Test Mode lets you try out the NextPay API without processing real transactions or moving real money. It is a sandbox environment that mirrors the production API but uses simulated data.

How to use Test Mode:

  1. Generate a test API key from Settings > API Keys and toggle the Test Mode switch.
  2. Use the development API URL: https://unique-hare-768.convex.site
  3. Make API calls with your test key. All requests will be processed in the sandbox.

What works in Test Mode:

  • Creating and listing directory entries
  • Creating payout requests (simulated processing)
  • Creating and sending invoices (no real emails sent)
  • Viewing audit logs
  • All CRUD operations on workspace data

What is different in Test Mode:

  • No real money is moved. Payouts are simulated with instant success or configurable failure.
  • No real emails or SMS notifications are sent.
  • Test data is periodically reset and should not be relied on for long-term storage.

Test Mode is essential for building and testing integrations before going live. We recommend running your full integration test suite against Test Mode before switching to production API keys.

On this page