Skip to main content

Version: 21.05 (EOL)

APIs for Developers


The Temenos Journey Manager (TJM) platform provides a suite of developer aids to help you build great TJM solutions. TJM has an extensible service-based architecture that allows developers to create sophisticated form transaction applications using plug-in services for key extension points. The foundation for TJM solution development is Journey SDK.

Generally, all Journey API documentation is updated with each software release. However, if the documentation you're looking for is not updated in this release, you can refer to the documentation for the most recent prior release. Any exceptions to this are noted in the release notes.


This documentation portal is focussed on bringing you up-to-date documentation for the latest release and recent supported releases. However, if you're looking for information about older releases or legacy products, see Documentation for older releases.

Using this documentation

Navigation paths are provided so that you can go directly to a specific release version of a topic or documentation set.

Navigating to documentation by topic or release version

  1. Navigation Bar: You can navigate to the latest release of a specific documentation set by selecting an item from the Navigation Bar at the top of the screen.
  2. Release Selector: While viewing a topic, you can switch to a different version (if available) by selecting an item from the Release Selector. If the topic isn't available for the selected release, the home page (APIs for Developers) for the release is displayed instead.
  3. Topics List: Select an item from the Topics List to navigate to that topic or documentation set in the currently selected release (as shown in the Release Selector).
  4. Topic Version: The Topic Version is displayed at the top of each topic. The Topic Version is also included at the top of the first page when printing a topic.

Above the Topic Version, you'll find some handy icons.

  • Print: Print the current topic using your browser's print feature.
  • Copy URL: Copy the current topic's URL to the clipboard.
  • Theme: Toggle between light mode and dark mode.
  • Expand: Expand the topic content, hiding the cards on the right (In this topic, Need More Help?).

What's in this release?

This release includes developer documentation for the following Journey Manager modules and features.

new_releases New in this release      picture_as_pdf Available as a PDF

These release notes relate to this release.

What about Journey Workspaces?

Journey Workspaces is not included in this release. You can use Journey Workspaces from any prior supported release with the other software in this release.


The following Journey API downloads are available from the Journey Manager resources website (login required).

ModuleAvailable downloadsDownload
Journey ManagerJourney SDK installer
Fluent API documentation (Javadoc)
Core API documentation (Javadoc)
Journey MaestroMaestro Offline Build Tool (Maestro CLI)
Maestro Source Code Management (SCM) client
Access to downloads

As a registered member of our resources website, you can request access to Journey API downloads distributed with each Journey Manager release. Here's how to request access.

About ...

Journey SDK

The TJM Software Developers Kit (Journey SDK) includes tools to support the development of TJM applications using modern developer tools and continuous integration (CI) build systems. Journey SDK includes the Transact Fluent API and Maestro API.

Services Guide

TJM has an extensible service-based architecture that supports development of sophisticated form transaction applications. This architecture uses pluggable services for key extension points. The Services Guide covers a variety of topics relating to these services and how to use them, including:

  • Groovy Guide: An introduction to the Groovy scripting langage.
  • Service Development: Guidelines for developing Journey Manager services using Groovy.
  • Groovy Services API: Groovy Service API documentation and script examples.
  • REST API: A REST API for external systems calling Journey Manager.
  • Workspaces API: A set of APIs for the Workspaces portal that allow external systems to integrate with Journey Manager.

Open UX

Open UX is a set of JavaScript libraries for building applications on the TJM platform. It allows you to develop onboarding experiences using the tools you're already familiar with while taking advantage of TJM on the back-end.


While Open UX is not currently under development, the Journey Manager interfaces that support Open UX continue to be supported.

Open UX documentation is available as a PDF.

Exchange Framework

The Exchange Framework, formerly known as Transact Integration Framework (TIF), makes it easier for developers to build TJM integrations in an efficient, standardised and scalable manner which helps to reduce the ongoing costs of upgrades and maintenance.

Journey Workspaces

Journey Workspaces is a review and approval portal, designed to support resolution and customer service activities for account opening and onboarding. Workspaces enhances the customer experience and improves staff productivity by increasing efficiency and accuracy of the application review process, often a source of onboarding delays and customer dissatisfaction.

Workspaces is an integral module of the TJM platform, designed and developed from scratch to replace the previous generation Work Space product, adding powerful capabilities based on new REST APIs that will enable users to find and manipulate applications quickly.


If you're not involved in setting up and configuring a Workspaces portal and just want to learn how to use Workspaces, take a look at the Workspaces User Guide.

Maestro Offline Build

The Maestro Offline Build (MOB) tool is a command-line interface for building Maestro forms outside the Journey Maestro web user interface (UI). Building forms from a command line allows the build process to be automated through scripting, and ultimately incorporated into a Continuous Integration/Continuous Deployment (CI/CD) pipeline.

The MOB tool also introduces the ability to build multiple forms in a project in one step, either using a single command or by scripting a list of form builds. This can be particularly useful to update all forms that use a single updated form template.

Journey Narrative

Journey Narrative is a new way of thinking about TJM application design, with the intention of satisfying the following objectives.

  • Simplify the task of controlling a user's flow through an application.
  • Make page navigation configurable on the server-side.
  • Enable automated testing of the application flow.
  • Move complex business logic and validations to the server.
  • Reduce the burden on form developers in Maestro or other tools.

A Narrative describes a customer journey. It defines an application's pages, the paths a customer can take through those pages, and all of the actions that occur along the way. Skipping any page (due to an error or malicious activity) or action would leave the application in an invalid state. A Narrative uses a Narrator to ensure that pages are visited and actions are performed in the correct order. If any of these rules are broken, the Narrator rejects the application.

Terms of use

The terms of use for our software and this website are available online.