Login to Fermata Control

Use Cases

Get a demo

Fermata Documentation

API Reference

Try Fermata

Get all accounts

Accounts are the customers of Companies. They are what are actually generating events and being billed

string

Test MVB 1

apiKey

Welcome to Fermata

Basics & Definitions

Overview

Fermata Control

Within the Treasury Management area of Fermata Control, you can view and manage each customer's account with your platform. 

Account Management

As we like to say... Fermata denotes a pause. There are multiple ways you can pause an end user's platform access, or adjust billing behaviors.

Pause

Webhooks

Also known as feature flags, we support the following product entitlements features

Product Entitlements

These are links you can use to manually collect account card details and begin billing

Payment Links

Capturing Payment

API Tutorial 101

General Fermata Tutorial

Create a new billing account for your user that you can then collect payment from our push events to.

If you leave off any Stripe information on the account, Fermata will
create a Stripe customer ID for them.

You can pass a credit card token to add a payment method to that account.

If you already created a Stripe customer for them, then pass in the ID and we will attach to it.

We can generate a page to collect credit card information and bill them for the given plan
if you specify the `enable_card_collector` option

Create a new account

Get current balance for a given denomination for an account

Get a single account

Edit an account information

Get all balances on account

Get transactions for account

Push an event to Fermata for the account.

The event will be billed based on whatever rules are on the account or you can specify manual override parameters

Requests don't have to bill at all. You can just push events to Fermata to track them

Push Events

Get webhooks

Create a new webhook

Once you add a webhook url and get a webhook_id then you can choose to subscribe that webhook to various topics

Currently supported:

* `pause_balance`: Notification triggers when an account drops below zero on any balance account

More coming soon

Subscribe a Webhook URL to a specific topic

Create Plan for Company

API Documentation

APIs

Get all accounts

Authorizations

Path Parameters

Query Parameters

Response