Documentation for a newer release is available. View Latest

Release Notes for IPF-2025.2.0

This page details everything required to get going on IPF Release 2025.2.0 made available on 21st August 2025

Change Spotlight

  • Mongo Client-Side Field Level Encryption/CSFLE(PAY-12392)

  • New reactive operations for outputting file content added to ipf-file-manager-api (PAY-14190)

  • Operational Dashboard now supports Cancel functionality for future dated/warehoused payment (transaction or batch) prior to execution date/time (PAY-12555)

  • DPS V2 Integration for CSM Reachability and the Operational Dashboard (PAY-11749, PAY-13627)

  • SCT Rulebook changes (PAY-12238)

  • Akka clusters now support different Akka versions for zero downtime rolling upgrades (PAY-13438)

  • HTM now allows registration via kafka in addition to http (PAY-11099)

  • Recall and payment search result table now configurable (PAY-11978)

Fix Spotlight

  • Mapping function not correctly initialised when used in subflow initialisation behaviour (PAY-14024)

  • Passing business data between sub flows causes incorrect validation failure in MPS (PAY-14117)

  • ActionHelper generation when using HTM FloClient from an imported module (PAY-14481)

  • Prevent null pointer on ultimate debtor and creditor on address validations (PAY-14888)

Breaking Changes

  • The test framework now runs exclusively on JUnit 5 (Jupiter). You may face compilation failures if using JUnit-4-specific annotations or assertion classes. See migration for more specific migration steps.

  • Bulker

    • Module ipf-bulker-outputstream and its implementations have been removed. Please use ipf-file-manager-api

    • A new configuration property has been introduced to configure ipf-bulker output.

    • The S3FileDeleter in ipf-file-manager previously logged errors when exceptions occurred without propagating the failure. It now propagates the exception in addition to logging.

  • VoP Responder

    • Account Management API field 'RetrievePartyDetailsResponse.nm' has changed to 'RetrievePartyDetailsResponse.names' and is now a list of names

    • Match thresholds were defined per account type only. In this release match thresholds must be defined per processing entity and account type.

    • In the Processing Archive model the following fields have been renamed:

      • 'ProcessingArchive.matchedName' to 'ProcessingArchive.scoredName'

      • 'ProcessingArchive.accountPayeeName' to 'ProcessingArchive.accountPayeeNames' and is now a list of names

  • VoP Requester

    • Configuration ipf.verification-of-payee.requester.scheme-membership-ids has been removed from the hierarchy. Clients overriding values (e.g. processing-entities) underneath this path should remove scheme-membership-ids from the path.

    • Default processing-entity-code was previously "". This has been updated to default instead of empty string, consistent with VoP Responder

    • rvm parameter should be specified in addition to name for scheme configuration

  • Connector

    • DeadLetterAppender interface stage return type changed from CompletableFuture<Void> to CompletionStage<Void> (PAY-14532)

  • Scheduler

    • the SchedulerConnectorInterface (from the scheduler-client-connector-http maven artefact) uses HTTP API models as method arguments, as opposed to 'core' models.

    • HTTP API takes the ExternalTriggerCommand object in the nested payload for scheduling new jobs

    • Scheduler Floclient: renamed PaymentAsyncScheduleCompletedCommand to SchedulePaymentReleaseCommand

  • Payment Releaser (Payment Entries Processor)

    • Payment Releaser has become a generic Payment Entries Processor, multiple core classes and methods are renamed in the process

    • ipf.core.payment-releaser root config path changed to ipf.core.payment-entry-processor

    • releaseExecutionInfos database collection is renamed to executionInfos, and now requires a compound unitOfWorkId_1_actionType_1 index

  • ODS Inquiry V2 API

    • Reformat of transactionData in ODS details API (/api/v2/views/details/{unitOfWorkId})

      transactionData field now returns an empty object and is deprecated.

    • New field mds added to details schema, which returns all the latest mdsObjects for a unitOfWorkId, grouped by MDS object type.

    • Changed /api/v2/all/pds-objects/{name} to /api/v2/all/pds-objects/{odsObjectId} to align with other processing data API’s.

  • Csm-Reachability

Please see Migration Steps for more details

Advance Warning of API Removal

ODS Inquiry API V1

In 2026.2.0 ODS Inquiry API V1 will no longer be supported, and will be removed from ODS. Client libraries within this release will also remove V1 support.

It is recommended that you migrate to at-least V2. See the V2 Migration Guide for more information.

ODS Inquiry API V3 is planned to be released as part of IPF 2025.4.0

IPF Processing Data V1.

In 2026.2.0 IPF Processing Data API V1 will no longer be supported. IPF applications will not be capable of producing and consuming V1.

IPF currently produces V2 by default, and can produce V1 when explicitly configured to do so.

It is recommended that you migrate to V2 as soon as possible. Please ensure none of your IPF applications are configured with ipf.processing-data.egress.schema-version = 1. You can either remove the config completely, or explicitly set to ipf.processing-data.egress.schema-version = 2.

IPF processing Data V3 is planned to be released as part of IPF 2025.4.0

Release Details

Binaries

The core binaries are available from IPF-Releases.

Lightbend Telemetry (formerly known as "Cinnamon") binaries are available from IPF Lightbend.

Akka/Alpakka binaries from 2.9.x onwards are no longer on Maven Central and are available from the Akka Library Repository which Icon mirror.

To enable the new mirror, add the following to your settings.xml in the <repositories> section:

<repository>
  <id>akka-repository</id>
  <name>Akka library repository</name>
  <url>https://nexus.ipf.iconsolutions.com/repository/akka-repository</url>
</repository>

Some MPS dependencies are also mirrored by Icon and can be found by adding the following repository to the same section:

<repository>
  <id>icon-thirdparty</id>
  <name>IPF icon-thirdparty repository</name>
  <url>https://nexus.ipf.iconsolutions.com/repository/icon-thirdparty</url>
</repository>

Add the following to your <servers> section for each new repository:

<server>
  <id>Repository_name_here</id>
  <username>xxxx</username>
  <password>xxxx</password>
</server>

Where xxxx is the username and password repectively provided to you by Icon.

Developer App

The latest version of the Developer App is 2.4.21

Scaffolder

The latest version of the Scaffolder is 1.2.8

2025.2.0 Jar/Pom list

The Jars and Poms for 2025.2.0 and the associated versions are listed here: 2025-2-artifacts.xlsx