Forth, Inc

Forth Pay

This section contains any user guides specific to the Forth Credit feature.

User Guides

The Bulk APIs section makes handling large volumes of data faster and easier. Instead of processing records one by one, you can batch update or upload multiple entries in a single request—saving time and improving efficiency. Whether you&apos;re managing massive datasets or streamlining workflows, this functionality is built to optimize performance and keep operations running smoothly.

Bulk APIs

The Compliance section is here to help you stay on top of regulatory requirements with ease. Instead of navigating complex compliance rules on your own, this section gives you the tools and guidance to keep your projects aligned with industry standards. Whether it’s data security, financial regulations, or governance, it’s designed to make compliance feel less overwhelming, so you can focus on building with confidence.

Compliance

The Core Objects section is the backbone of customer management, handling everything from interactions and accounts to financial agreements. Whether you&apos;re managing contacts, companies, debts, documents, enrollments, loans, or settlement offers, this section keeps everything organized and accessible. It ensures smooth communication and tracking, helping you maintain clarity and efficiency in client-related activities.<div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div>

Core Objects

The Lookups section is designed to make searching and managing predefined data effortless. Instead of manually keeping track of things like templates, hold reasons, types, subtypes, and statuses, this tool provides a structured way to retrieve and organize key reference information. Whether you need to pull status updates or filter through categories, everything is accessible exactly when you need it, keeping operations smooth and efficient.

Lookups

The Processing section keeps draft management and fee handling organized and hassle-free. Users can create, update, retrieve, or delete drafts, with the flexibility to activate, deactivate, or cancel them as needed. It also provides easy access to ACH credit fee information, enabling users to view and modify fees without having to dig through complicated records. Everything is designed to keep workflows efficient and structured.

Processing

The Reporting section offers users powerful insights into their transactions, clients, holds, debts, and settlements. With access to detailed reports and analytics, users can track performance, analyze trends, and make informed decisions to optimize their business operations. This functionality provides a clear and structured view of financial data, ensuring efficient management and strategic planning.

Reporting

Clixsign

This section contains a user guide specific to the Clixsign feature. Clixsign is Forth&apos;s proprietary electronic document signing platform. To enable this platform, please contact <a href="mailto:Support@setforth.com" target="_self">Support@setforth.com</a>.

This endpoint allows you to initiate the sending of a Clixsign document to a specified client. By providing the necessary documents and signer details, you can trigger the document delivery process efficiently.

Create Signing Request

Blank

Forth Pay API

Api-Key

Production

Sandbox

Activate Debit

Activate Fee

Activate Refund

Activate Settlement Payment

Add Bank Account

Add Comment

All Settlement Decisions by Date

Attach Settlement Letter

Bank Accounts

Cancel Enrollment

Cancel Unprocessed Debit

Cancel Unprocessed Fee

Cancel Unprocessed Refund

Cancel Unprocessed Settlement Payment

Client Balance Reports

Client Report

Clients on Gateway Hold

Request a Signature

Companies

Clients

Create ACH Credit Fee

Create Co-Applicant

Create Company

Create Client

Create Debit

Create Debt

Create Forth Pay Creditor

Create Forth Pay Portal User Account

Create ForthPay Creditor Address

Create Multiple Drafts / Debits

Create Performance Fee

Create Refund

Create Settlement

Create Settlement Payment

Creditors

Deactivate Debit

Deactivate Fee

Deactivate Refund

Deactivate Settlement Payment

Debits

Debts

Decisions

Delete Unprocessed Debit

Documents

Enroll Client

Enrolled Clients

Enrollment

Fees

Forth Pay API Workflow Guide

Forth Pay Quick Start Guide

Generate Account Closure Form

Generate Bank Change Document

Generate CAA Document

Generate Document Based on Lookup Key

Generate One Time Debit Document

Generate Risk Returns Form

Request Hold Release

Get Bank Account

Get All Companies

Payees

Get Payee

Update Payee

Get All Documents

Get Document

Upload Document

Graduate Enrollment

Pause Enrollment

Re-Enroll Client

Resume Enrollment

Get Client

Portal

Send Password Reset Email

Update Co-Applicant

Update Client

Get All Creditors

Get Creditor

Get Debt

Update Debt

Settlement Offers

Get Settlement

Update Settlement

Void Settlement

Virtual Bank Accounts (VBA)

Get All VBAs

Get VBA

Get VBA Activity

Update VBA Reserve Amount

VBA to Client Funds Transfer

VBA to VBA Funds Transfer

Get Cancellation Reasons

Get Compensation Templates

Get Decision Statuses

Get Document Templates

Get Document Types

Get Forth Fee Amounts

Get Freeze Map

Get Hold Reasons

Get Settlement Offer Statuses

Get Transaction Statuses

Get Transaction Subtypes

Get Transaction Types

Get Check Image

Get Settlement Decision

Mark  as Paid

Mark as Returned

Transactions

Get Debit

Update Debit

Get Fee

Update Fee

Refunds

Get Refund

Update Refund

Settlement Payments

Get Settlement Payment

Update Settlement Payment

Outstanding Debts

Settlements

Shipped Check Payments

The Get Cancellation endpoint simplifies the cancellation process by offering a clear list of valid reasons to choose from. Instead of manually tracking or guessing, it provides structured reason codes and descriptions, ensuring consistency and accuracy. With this endpoint, cancellations become easy to manage and well-documented, keeping operations smooth.

This endpoint simplifies placing holds by providing a structured list of valid reasons to choose from. It eliminates the need to search manually by delivering clear reason codes and descriptions, making it easy to track and apply the right hold with accuracy and consistency.

This endpoint retrieves available Forth document types, giving you a clear breakdown of what’s in your project. It helps you quickly understand the structure and efficiently manage files, keeping everything organized and accessible.

This endpoint simplifies document generation by providing a list of ready-to-use templates. No need to start from scratch; just pick a template, complete with its ID, name, and required data details, making the process efficient and structured. It’s a great way to streamline your workflow while keeping everything organized and hassle-free.

If you&apos;re working with compensation structures, this endpoint helps by providing a list of available templates to use. Instead of setting up calculations from scratch, you can quickly find and apply the right template, complete with its ID, name, and details on compensation components. It’s an efficient way to streamline payment processes and keep everything organized.

When you need to process transactions, this endpoint helps by giving you a full list of valid transaction types. Each transaction type represents a specific financial action, such as payments, refunds, fees, advance, recoups or transfers. Instead of manually keeping track, it provides a structured response with type codes and descriptions, making it easy to categorize transactions and keep things running smoothly.

If you need to break transactions down further, this endpoint helps by providing a list of valid subtypes for different transaction types. Instead of manually sorting through subcategories, this makes it easy to pull a structured list with subtype codes and descriptions, ensuring transactions stay well-organized and easy to track.

When handling transactions, this endpoint helps by giving you a clear list of possible statuses, like Pending, Completed, or Failed. Instead of guessing where a transaction stands, you’ll get structured status codes and descriptions to make tracking effortless. It’s a simple way to stay organized and ensure everything is moving smoothly.

If your system has scheduled freezes or specific rules for restricting operations, this endpoint helps map out those details. Instead of manually tracking when certain actions are paused, it provides a clear breakdown of freeze configurations, ensuring you always know what&apos;s happening behind the scenes. It will help you to stay ahead of system pauses and keep things running smoothly.

When managing settlement offers, this endpoint helps by giving you a full list of possible statuses, like Draft, Sent, Accepted, or Rejected. Instead of manually tracking where an offer stands, you’ll get clear status codes and descriptions, making it easy to keep everything organized and up to date.

Whenever a decision is made, this endpoint helps by providing a clear list of statuses, like Pending, Approved, or Denied. Instead of manually tracking progress, you’ll get structured status codes and descriptions to make everything easy to follow.

This endpoint retrieves a list of fee amounts associated with Forth Pay (formerly DPG), providing a structured breakdown of fee codes and their corresponding amounts. The response is typically a JSON array, making it easy to track, organize, and apply fee structures accurately.

If your system has scheduled freezes or specific rules for restricting operations, this endpoint helps map out those details. Instead of manually tracking when certain actions are paused, it provides a clear breakdown of freeze configurations, ensuring you always know what&apos;s happening behind the scenes. It will help you to stay ahead of system pauses and keep things running smoothly.

If your system has scheduled freezes or specific rules for restricting operations, this endpoint helps map out those details. Instead of manually tracking when certain actions are paused, it provides a clear breakdown of freeze configurations, ensuring you always know what's happening behind the scenes. It will help you to stay ahead of system pauses and keep things running smoothly.

code

message

status

response

Sections

Get Freeze Map

Header Parameters

Response

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

Get Freeze Map

Header Parameters

ResponseExpand all

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Response