Documentation

Use Cases

Get a demo

Fermata Documentation

API Reference

Try Fermata

Delete webhook

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

Capturing Payment

API Endpoints

API Tutorial 101

API Tutorial 201

General Fermata Tutorial

Get all accounts

Creates a new user treasury account. If a valid stripe token isn't passed, then we will create a stripe customer ID for them

Create a new account

Get current balances for a given denomination for an account

Get a single account

Edit an account information

Add some form of balance to a user's account and charge them for it

Add Balance To User's Account

In the case of changing monthly refill parameters, these will take effect on the next renewal if you use this endpoint. For mid-month renewals see other endpoint

Modify Automatic Refill Parameters for Account

Get transactions for account

This endpoint changes the auto-refill monthly setting on the account balance in a prorated way. It is only used to increase the refill amount. It follows the following process:
Issue new tokens to account for given cost
Figure out value of remaining tokens from previous refill and subtract that amount from the cost of the new refill
Cancel all remaining tokens from previous refill
User's credit card is charged that prorated calculated cost
User's refill day is modified to start a new month today

Mid-month modification of monthly auto-refill

Push an event to the billing engine. This endpoint can accept very high volume of requests and will be low latency. It returns a success if the data appears to be valid

Push Events

Get webhooks

Create a new webhook

Retrieve the information of the user with the matching user ID.

Get User Info by User ID

Update a user

Create New User

A plan basically acts as a template of account balance denominations and parameters that you can apply to an account upon creation

Create Company Plan

API Documentation

APIs

Delete webhook

Authorizations

Path Parameters

Response