Getting Started on Sandbox

To support such a wide range of fintech propositions it is necessary for Eclipse to be a highly configurable platform. However, when onboarded to the Eclipse Sandbox Environment a set of default configurations are applied so that tenants can immediately start testing and developing against the Eclipse APIs. The Sandbox Environment is fully functioning other than the ability to top-up and withdraw with real money.

In particular, the following is preconfigured:

Wallets

• Default wallet types are created for System Wallets, Digital Wallets and Card Wallet
• A Tenant Root System Wallet is created and funded
• Source System Wallets are created and funded - this allows immediate experimentation with wallet top capabilities
• A Tenant Digital Wallet is created and funded - this allows immediate experimentation with wallet transfer capabilities

Permissions

Eclipse supports granular authorization through roles, positions and permissions (Granular Authorization), however to enable quick experimentation, new tenants are configured to allow all permissions on all roles and positions.

Admin User

An admin user is created for the tenant as part of the onboarding process.

Eclipse Admin Portal

An important entry point for developing and testing against Eclipse is the Eclipse Admin Portal Guide

The portal consumes the Eclipse API’s to perform ad-hoc, CRM and general administration tasks so it can be a good way to understand the platform capabilities and look at the API’s in use and the payloads that are sent/received.

A typical starting point when testing and developing against the Eclipse Sandbox Environment
is:

1. Authorization

JWT is used to ensure the secure transmission of information when calling the APIs (refer to Authentication & Authorisation for details on requesting and refreshing tokens). Eclipse Admin Portal takes care of this when logging into the portal so is a good starting point to get familiar with the Eclipse platform capabilities without needing to implement the API authorization prerequisites.

2. Create Customer

This can be done by using the APIs (refer to Create Customer) or done directly in the Eclipse Admin Portal.

3. Add KYC Documentation

This can be done using the APIs (refer to add KYC Doc Info) or done directly in the Eclipse Admin Portal.

4. Perform KYC

When onboarded to the sandbox environment, default KYC prerequisites are configured on the Digital and Card wallet types. For early testing, this can be removed (refer to How to define KYC/KYB parameter on wallet types) but it is advised that KYC customer journeys are rigorously tested during sandbox testing as they are a critical part of the customer experience.

Details on how the KYC process works are detailed here KYC FAQs.

Performing KYC can be done using the APIs (refer to Kick Off Ratify) or done directly in the Eclipse Admin Portal.

5. Create Digital Wallet

This can be done using the APIs (refer to Create Wallet) or done directly in the Eclipse Admin Portal.

6. Transfer Funds between Wallets

Using the funded Tenant Digital wallet as a float, developers can test transfers between wallets. This can be done using the APIs (refer to Transfer Funds between wallets) or done directly in the Eclipse Admin Portal.

7. Wallet Topup

In the sandbox environment, top-up mechanisms can be tested for all preconfigured top-up sources through the funded source system wallets. This can be done using the APIs (refer to Wallet Top-Up) or done directly in the Eclipse Admin Portal

For testing card, top-ups refer to Sandbox Test Accounts for test card details to use.

8. Wallet Withdrawal

Withdrawals can be tested in the sandbox environment for integration testing but the final payout partner action is not invoked: in the sandbox environment, you can not withdraw real money.

This can be done using the APIs (refer to Wallet Withdrawal) or done directly in the Eclipse Admin Portal

In the sandbox environment, you can also simulate a successful or failed withdrawal by setting the status to SUCCESSFUL or ERROR_PERM with

PUT/eclipse-conductor/rest/v1/tenants/{tenantId}/wallets/{walletId}/withdrawals/{withdrawalId}

📘

Note:

This can only be done in the sandbox environment.

For sandbox test accounts for QR, withdrawal, top up and acquiring refer to Sandbox Test Accounts

Once you are familiar with the basics of the platform and available APIs and have a clear idea of the proposition you want to enable, refer to the detailed Use Cases for implementation details on the range of capabilities that Eclipse can enable.