Skip to main content

Documentation Index

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

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

Formance Cloud is a fully hosted and managed deployment environment which can be used for your production applications. Information regarding the available plans can be found on the Formance Cloud Pricing page.

​
Available Regions

Formance Cloud is available in the following regions:
Region IdentifierDescriptionAvailability
aws-us-west-2-hostingUS, Oregon (AWS)General Availability ✅
aws-af-south-1-hostingAfrica, Cape Town (AWS)General Availability ✅
aws-eu-west-1-hostingEU, Ireland (AWS)General Availability ✅
aws-sa-east-1-hostingSA, São Paulo (AWS)General Availability ✅
aws-us-east-1-hostingUS, Virginia (AWS)General Availability ✅
aws-ap-southeast-1-hostingAPAC, Singapore (AWS)Available upon request

​
Getting Started

​
Prerequisites

Before creating a stack, ensure you have:

​
Creating a Stack

Once you have set up a billing account (by reaching out to us), your available production deployments quota will be increased. You can then create a production deployment: 
fctl stack create my-stack
To specify a region: 
fctl stack create my-stack --region aws-eu-west-1-hosting

​
Listing Regions

To list all available regions: 
fctl cloud regions ls
To get detailed information about a specific region, including available modules: 
fctl cloud regions show aws-eu-west-1-hosting
Example output: 
# 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, stargate, wallets, webhooks

​
Managing Modules

By default, a stack includes the following modules:
  • Ledger - Double-entry accounting
  • Gateway - API gateway
  • Payments - Payment provider integrations
  • Auth - Authentication
  • Stargate - Connectivity layer

​
Enable/Disable Modules

You can enable or disable additional modules using fctl: 
# Enable a module
fctl stack modules enable orchestration

# Disable a module
fctl stack modules disable orchestration

​
Available Modules

The following modules can be enabled on your stack:
ModuleDescription
ledgerDouble-entry accounting system
paymentsPayment provider integrations
walletsDigital wallet management
orchestrationWorkflow orchestration (Flows)
reconciliationPayment reconciliation
webhooksEvent notifications
authAuthentication
gatewayAPI gateway
stargateConnectivity layer

​
Verifying Your Stack

After creating your stack, verify it’s working properly: 
# Check stack status
fctl stack show my-stack

# Query ledger server info
fctl ledger server-infos --stack=my-stack

​
Managing Your Stack

​
List Stacks

fctl stack ls

​
Delete a Stack

fctl stack delete my-stack

​
Information and Requests

For more information and any requests regarding the Formance Cloud offering, please contact us at support@formance.com. As a SOC-2 Type II certified company, we take security and privacy seriously — and will be happy to answer any questions you may have, as well as provide you with a copy of our SOC-2 report upon request.