Hyfin Logo
API Docs 3.0API Docs 3.1API Docs 4.0 SimpleAPI Docs 4.0

Introduction

Welcome to version 4.0 of the Hyfin API. The API allows third-party applications to send payment requests to customers via text message, email or both. Once received, the customer can then view and pay the invoice from their mobile phone or any device without the need to download and install an application.

An API access token is required to access the API. Please visit the Authentication section for details on how to obtain and use API access tokens.

Onboarding

The Hyfin platform has support for multiple levels of access. Below are definitions of the available business structures within the API along with how they relate to each other.

Name
Definition
Site Enterprise
An optional Site Enterprise can be created to allow multiple Site groups and Sites to be organized and managed under a single Site Enterprise.
Site Group
An optional Site Group can be created to allow multiple Sites to be organized and managed under a single Site Group.
Site
A Site should be created for each unique business location or for each unique merchant id assigned to a business. Sites can belong to Site Groups and Site Enterprises but is optional. However, a Site must belong to an Agency.

Tier Structure

The following table represents a few examples in which you can setup the structure for your Sites.

Enterprises
Site Enterprise
Site Group(s)
Site(s)
Multi-site Companies
Site Group
Site(s)
Single-site Companies
Site

Site

Once a Site is created using the Hyfin API and the site_id has been assigned, you can then call any of the Site level endpoints.

The Site level APIs can be used to add or update invoices within the Hyfin application. When the invoice is added to Hyfin, a payment request will be automatically generated and the customer will be notified via text message, email or both based on the notification options set on the customer record.

If the customer is viewing the invoice on their device and it gets updated, a message will display letting the customer know the invoice has been updated and the new version of the invoice will automatically be displayed on the customers device.