Introduction to Payments

The Payments module provides read access to payment and settlement data associated with invoices managed through the CFIS framework.

Once invoices are distributed and payment control is active, the agency processes incoming payments and generates settlements on behalf of the creditor.

This module allows clients to retrieve that data and reconcile it against their own records.

Payments process

Endpoints Overview

Payments GET

Retrieves a list of payments that have been allocated to invoices by the agency. Each record includes the case identifier, invoice number, payment reference, payment date, and amount.

This endpoint is the primary source for tracking individual payment transactions against active cases.

Settlements GET

Retrieves settlement records representing batched disbursements from the agency to the creditor.

Each settlement contains a summary of the total amount, payment date, IBAN, and BIC, along with a breakdown of the individual transaction rows — including case identifiers, invoice numbers, transaction types, and allocated amounts per row.

The case identifier (CaseId) returned in the Payments response corresponds to the same identifier available via the Invoices module. It is recommended to store this identifier during invoice distribution to enable efficient cross-referencing between modules.

Payments process#

Endpoints Overview#

Payments process

Endpoints Overview