Getting Started on Sandbox

Eclipse is a highly configurable platform designed to support a wide range of fintech propositions. To help new tenants start quickly, the Eclipse Sandbox environment comes with preconfigured defaults that allow immediate testing and development against the Eclipse APIs.

The Sandbox environment mirrors production behaviour in nearly all aspects, except that no real money is moved. This ensures safe experimentation, integration testing, and demonstration without impacting live systems.

Preconfigured Elements in the Sandbox

When a tenant is provisioned in the Sandbox, the following is available by default:

Wallets

Default wallet types for System Wallets, Digital Wallets, and Card Wallets.
Tenant root System Wallet, pre-funded for testing.
Source System Wallets, pre-funded to allow immediate wallet top-ups.
Tenant Digital Wallet, pre-funded to test wallet transfers.

These defaults enable developers to experiment with wallet and transaction workflows immediately.

Permissions

Eclipse supports fine-grained access control using roles, positions, and permissions. Sandbox tenants are configured with a default set of permissions that allow typical development and testing scenarios. Permissions can be refined later for production readiness.

Admin User

An administrative user is created as part of tenant onboarding. This user can access both the APIs and the Eclipse Admin Portal.

Eclipse Admin Portal

The Eclipse Admin Portal is a key interface for exploring and testing the platform. It uses the same APIs available externally, making it useful for:

Understanding API payloads and workflows
Performing ad-hoc administration
Conducting CRM-style operations

Using the portal is often the fastest way to get familiar with Eclipse before implementing API calls in code.

Typical Sandbox Getting Started Flow

Developers often follow these steps when beginning integration with the Eclipse Sandbox. Each step can be completed using the APIs directly or via the Admin Portal.

1. Authentication

Eclipse uses JWT-based authentication to secure API access. For details on requesting and refreshing tokens, see Authentication & Authorisation.
The Admin Portal handles authentication automatically, providing a convenient way to explore the platform without implementing token management immediately. For production deployments, PKI-based authentication is recommended: PKI Authentication.

2. Create a Customer

Create a customer using the APIs (Create Customer) or via the Admin Portal.

3. Add KYC Documentation

Upload KYC documents using the APIs or the Admin Portal. See KYC Use Cases for supported workflows.

4. Perform KYC

Default KYC rules are applied to Digital and Card wallet types in the Sandbox. These can be relaxed for early testing (Defining KYC/KYB Rulesets), but full KYC journeys should be tested thoroughly, as they are critical to the customer experience.
Perform KYC via the APIs (Kick Off Ratify) or Admin Portal. Additional details are in the KYC FAQs.

5. Create a Digital Wallet

Create a digital wallet for a customer using the APIs (Create Wallet) or Admin Portal.

6. Transfer Funds Between Wallets

Use the pre-funded tenant Digital Wallet to test transfers between wallets. APIs (Transfer Funds Between Wallets) or Admin Portal can be used.

7. Wallet Top-Ups

Test wallet top-ups using pre-funded source System Wallets. APIs (Wallet Top-Up) or Admin Portal can be used.
For card-based top-ups, refer to Sandbox Test Accounts. A commonly used test card is 4242 4242 4242 4242 (any expiry date and CVV).

8. Wallet Withdrawals

Withdrawals can be exercised end-to-end in the Sandbox. While requests are processed, no real money is moved. Developers can simulate different withdrawal outcomes directly within the Sandbox environment using the available APIs or the Admin Portal. You can also simulate a successful or failed withdrawal by setting the status to SUCCESSFUL or ERROR_PERM.

Refer to Sandbox Test Accounts for QR, withdrawal, top-up, and acquiring scenarios.

Once familiar with the Sandbox workflows, APIs, and core concepts, refer to the detailed use case documentation for guidance across the full range of capabilities that Eclipse provides.