Collection & Payment Control

The Collection & Payment Control module provides the core API endpoints for managing the full lifecycle of outstanding receivables — from submitting cases to Cash-In's payment control system through to monitoring case progress, recording received payments, and retrieving settlement data.

This module is used across two service types:

Invoice Lifecycle — invoices distributed through Cash-In are automatically transferred to payment control after distribution. The endpoints in this module allow you to monitor those cases and keep receivable data up to date.

Debt Collection — for creditors who manage their own invoice distribution, outstanding receivables can be submitted directly to Cash-In as collection cases using the endpoints in this module.

Endpoint groups

Case management

Submit new collection cases, retrieve full case details, and get debtor summaries. Each case tracks the status of one or more receivables through the reminder and collection process.

Receivable updates

When a debtor makes a payment directly to the creditor, the receivable status must be updated in Cash-In Payment Control.

This ensures the case is accurately managed and does not proceed unnecessarily to further collection stages.

Batch operations

Submit and check the status of multiple receivables in a single operation using the batch endpoints.

Settlements

Retrieve lists of settlements and detailed settlement data, including payment allocations per invoice. Settlements are generated 1–3 times per week for Invoice Lifecycle clients and once per week for Debt Collection clients, with payments sent to the creditor the same day.

Direct settlements

Retrieve direct settlement data for cases where payments have been allocated outside the standard settlement cycle.

Credit loss

Retrieve receivables that have been classified as credit losses. Credit loss data is published on the first day of each month.

Collection

Endpoint groups#

Endpoint groups