Skip to main content
Sandboxes are fully functional development instances for designing and testing your applications. They are free and available to all users.
Sandbox environments are intended for testing only, not production use. Data persistence is not guaranteed and may be lost at any time. Sandboxes also enter sleep mode after periods of inactivity, which can increase startup time. If you need a production-ready managed cloud environment, refer to Production Cloud.

​
Prerequisites

  • Install the Formance CLI (fctl) on your machine
  • Authenticate fctl against a Formance Cloud account

​
Creating a Sandbox

Create a Cloud sandbox: 
fctl stack create playground
Sandboxes are available for 15 days after their creation. After this period, they are automatically disabled and then completely deleted after 30 days. If you wish to keep your sandbox after it has been disabled, you can request its restoration.
The command will prompt you to select a region for your stack named playground. Select one ending with -sandbox to create a free sandbox. The command takes a few seconds to complete. It creates and provisions a sandbox in your account and automatically authorizes fctl. Verify your sandbox was created: 
fctl stack list
fctl stack show --name=playground

​
Enable/Disable modules in your Sandbox

By default, stacks include these modules:
  • Ledger
  • Gateway
  • Payments
  • Auth
  • Stargate
Enable or disable modules: 
fctl stack modules enable "wallets"
fctl stack modules disable "wallets"

​
Obtain available modules

View available modules for your region. The list appears under Capabilities > MODULE_LIST in the output: 
fctl cloud regions show c9abcd0df-480b-42c4-b5e7-dfght8e7c852
# Information
ID        | c9abcd0df-480b-42c4-b5e7-dfght8e7c852
Name      | example
Base URL  | https://example.com
Active    | Yes
Public    | Yes
Version   | latest
Last ping | 2024-05-15T14:09:02Z

# Capabilities
MODULE_LIST | auth, gateway, ledger, orchestration, payments, reconciliation, search, stargate, wallets, webhooks

​
Using your Sandbox

Use fctl to interact with your sandbox: 
# let's commit an example transaction to the quickstart ledger,
# increasing the balance of the @foo account by $1.00
fctl ledger send world foo 100 USD/2 --ledger=quickstart

# list transactions in the quickstart ledger
fctl ledger transactions list --ledger=quickstart