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 Transactions section is all about keeping financial operations smooth and efficient. Whether it’s processing payments, managing campaigns, handling Forth Credit services, or tracking transaction records, this area ensures everything flows seamlessly. With these endpoints, financial data stays organized and accessible

The Debits section helps users stay in control of their draft transactions, ensuring everything is managed before finalizing. Whether you need to create, retrieve, update, or cancel drafts, this section provides the flexibility to activate or deactivate transactions as needed. It’s an essential tool for handling pending financial processes smoothly and efficiently.

The Fees section provides functionality for managing and configuring fees associated with transactions and services within the system. Users can use this section to view, create, update, activate, deactivate, and cancel various types of fees, such as ACH credit fees and performance fees. With these endpoints, users can efficiently handle fee-related operations to ensure accurate and timely fee processing.

The Refunds section helps users stay in control of refund processing, making transactions smooth and efficient. Whether you need to initiate, activate, deactivate, or cancel a refund, these tools ensure quick and accurate adjustments to financial records. With this functionality, managing refunds is streamlined and efficient.<div class="slate-div"></div>

The Settlement Payments section gives users full control over payments tied to settlement transactions, making management smooth and efficient. With this functionality, users can view, update, activate, deactivate, or cancel settlement payments, ensuring financial processes stay organized and accurate. These tools are key for handling settlement transactions effortlessly through the API.

The Get Settlement Payment Endpoint lets users access specific payment details using a unique identifier, making financial tracking simple and efficient. Users can view transaction type, amount, and key dates, ensuring clear and accurate record-keeping. With this functionality, managing client payments is straightforward and hassle-free.

This endpoint lets you update an existing payment record, identified by its unique {id}, ensuring that payment details remain accurate and up to date. The request body should include a JSON object with the necessary updates to keep everything clear and properly structured. Don’t forget to include the leading / in the API code for correct implementation.

The Create Settlement Payment endpoint creates a new payment record within a settlement entry, allowing users to initiate a payment with all necessary details. The request body should include a JSON object specifying the payment information, ensuring everything is clear and properly structured. Be sure to include the leading / in the API code for correct implementation.

This endpoint activates a specific payment record, identified by its unique {id}, setting the payment into motion. Once active, the payment moves forward in processing or finalization within the system. Remember, make sure to include the leading / in the API code for proper formatting.

This endpoint deactivates a specific payment record, identified by its unique {id}, temporarily pausing payment processing within the system. Once inactive, the payment won&apos;t proceed until it&apos;s reactivated. Don&apos;t forget to make sure to include the leading / in the API code for proper formatting.

This endpoint cancels an unprocessed settlement payment, identified by its unique {id}, shifting it to a cancelled state. Once canceled, the payment won’t be processed any further, keeping financial records clear and intentional. Remember to include the leading / in the API code for proper formatting.

The Decisions section helps users engage with decision data tied to a specific project, making management smooth and intuitive. Users can access details, add comments, make payments, initiate returns, and retrieve images related to decisions. With this functionality, keeping track of project outcomes is effortless and efficient.

This endpoint deactivates a specific payment record, identified by its unique {id}, temporarily pausing payment processing within the system. Once inactive, the payment won&apos;t proceed until it&apos;s reactivated. Don&apos;t forget to make sure to include the leading / in the API code for proper formatting.

This endpoint deactivates a specific payment record, identified by its unique {id}, temporarily pausing payment processing within the system. Once inactive, the payment won't proceed until it's reactivated. Don't forget to make sure to include the leading / in the API code for proper formatting.

code

message

status

response

Sections

Deactivate Settlement Payment

Header Parameters

Path Parameters

Response

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Sections

Deactivate Settlement Payment

Header Parameters

Path Parameters

ResponseExpand all

Response Attributes

Response Attributes

What made this section unhelpful for you?

Response

What made this section unhelpful for you?

Response