Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.waycore.com/llms.txt

Use this file to discover all available pages before exploring further.

Waycore’s sandbox is designed for safe end-to-end integration testing using test API keys. The sandbox follows the same public API model as production, so you can build against the real connection, accounts, transactions, sync, and webhook flows without touching a real bank connection. Base URL: https://api.waycore.com Auth: test API keys (same auth flow as production)

​
How the sandbox works

When you use a test key, you can create and interact only with Waycore’s demo institutions. Resources created through that key live in the sandbox environment, including:
  • Connections
  • The accounts and transactions exposed through those connections
  • Sync cursors and sync events
  • Webhooks registered with the sandbox key
This means you can build and validate your full integration flow against realistic-looking demo data without affecting any real institution or production webhook setup.

​
Sandbox vs live

Sandbox and live are strictly separated.
  • A test key can only create connections to demo institutions.
  • A test key cannot access or modify resources created in the live environment.
  • A test key cannot trigger or receive live webhook deliveries.
  • A live key cannot operate on sandbox-only demo connections.
If you need to connect a real bank, you must use a live key. If you are using a test key, you should expect access to be limited to demo institutions and demo data only.
Treat sandbox and live as separate environments that happen to share the same API surface. You can develop safely in sandbox first, then move the same integration pattern to live with real institutions and live credentials.

​
Entities in sandbox

Entities themselves are not split into separate sandbox and live copies. They remain organization-level resources. However, sandbox connection creation is intentionally more restrictive:
  • When using a test key, you can only create connections against your organization’s default entity
  • When using a live key, the normal entity model applies
If your production integration uses multiple entities, assume that sandbox demo-bank connections will still belong to the default entity only.

​
Typical sandbox flow

  1. List entities and identify your organization’s default entity
  2. Search sandbox institutions via GET /v1/institutions
  3. Create or return a connection with POST /v1/connections
  4. Mark setup complete and wait for the connection to become ready
  5. Read accounts and transactions, exercise sync, and test webhook handling
The sandbox contains demo institutions and deterministic transaction data so you can validate backfills, sync cursors, and webhook-driven updates safely. To get sandbox access or test credentials, contact us at hello@waycore.com.