Skip to content
Login

Testing & Sandbox

The Heron sandbox is separate from production and does not move live funds. It supports the core integration workflow, but provider availability and simulated behavior can differ from production.

Sandbox Environment

Use the following base URL for all Sandbox requests:

https://api.tryheron.com/v1

Test API Keys

Generate sandbox API keys in the Heron Dashboard after switching to Test Mode.

TIP

Heron API key secrets are opaque values. Store sandbox and production keys separately in your own secret manager so you do not mix environments accidentally.

Provider Availability by Environment

Provider availability is environment-specific. Heron's provider catalog now tracks separate activation flags for sandbox and production rather than a single global active switch.

  • sandboxActive means the provider is available in the Sandbox environment.
  • productionActive means the provider is enabled for live production traffic.

Some providers may be enabled in sandbox before they are ready for production. The FAKE provider, for example, is intentionally sandbox-only.

Deterministic scenarios

Use the sandbox-only FAKE provider to exercise transfer lifecycle outcomes such as completion, review, failure, return, refund, and cancellation. The trigger amounts and expected webhook states are documented in Sandbox Scenarios.

Going Live

Before moving an integration to production:

  1. Complete your Business Verification (KYB) in the dashboard.
  2. Toggle the dashboard to Live Mode.
  3. Generate a Production API Key.
  4. Update your base URL to https://api.tryheron.com/v1.
  5. Confirm the providers you plan to use are production-enabled before sending live traffic.

Released under the Commercial License.