riverty logo

Docs

Overview

Our Collection API offers a range of functionalities designed to streamline debt collection processes and enhance operational efficiency. Below is a summary of the current capabilities, as well as upcoming features under development. These enhancements will expand the flexibility and scope of integration, enabling clients to stay ahead in managing claims and related transactions.

API Capabilities: Current and Upcoming Features

Functionality Status Description
Create a claim Supported Submit a new claim to our collection system.
Search for a claim Supported Search for an existing claim by relevant criteria.
Get a claim Supported Retrieve detailed information about a specific claim.
Get invoices for a claim Supported Retrieve the invoices associated with a claim.
Get costs for a claim Supported Retrieve the costs incurred for a claim.
Get interests for a claim Supported Retrieve the interest amounts for a specific claim.
Get reference contacts for a claim Supported Retrieve contact information associated with a claim.
Get history for a claim Supported Retrieve the activity history and status changes for a claim.
Create a payment Supported Record a payment made towards an outstanding claim.
Cancel a payment Supported Cancel a previously processed payment.
Create a credit waiver Supported Process a credit waiver for an outstanding debt.
Cancel a credit waiver Supported Cancel a previously issued credit waiver.
Create a recall (Partial/Total) Supported Recall a claim or part of a claim from collections.
Get all transactions within a period of time Supported Retrieve all transactions related to a specific claim.
Get the information of a document Supported Retrieve metadata and details about a document.
Get the content of a document Supported Retrieve the actual content of a document.
Pause a claim Coming Soon Temporarily pause a claim during the collection process.
Resume a paused claim Coming Soon Reactivate a previously paused claim.
Create a message Coming Soon Send a message related to a specific claim.