Versioning Schedule

New Evolving schema

Innovation is all about increasing momentum and staying ahead of the curve. Which is why we’ve designed Rapid 3 so you’ll never need to break your stride.

With Rapid 3 and our new evolving schema, you’ll get features as soon as they’re ready. No more waiting six months for new releases. No more taking hours to upgrade with each new release.

Our latest feature releases won’t break your integration, so you can stay on Rapid 3 for longer – saving you time and money. We’ll also let you know what features are coming, so you can plan ahead. 

Versioning strategy

When we release larger features, or breaking changes, we’ll launch them onto a new version, e.g. Rapid 4.

Our EPS Technology teams maintain one active version of the API, with another in development. When we launch the latest version that’s been in development, it will become active, and the previous version will be marked as deprecated. A deprecated version will be available for one year before we retire it, to give you enough time to move to the latest and greatest.

Please note that in 2022 we’ll be retiring all existing older versions of EPS Rapid (2.2, 2.3 and 2.4) so that we can focus on bringing you more flexibility and features on our evolving schema.

Terminology

Here are a few definitions to help you understand our versioning schedule:

Active: the current, active version of EPS Rapid. Non-breaking change features can be added to an active version at any time, and you decide whether to integrate these features or not.

Development: the upcoming version of EPS Rapid that we are working on.

Deprecation: When a version is marked for deprecation, it is an indication that the version will no longer be available after 1 year. This is a good time to upgrade to the latest active version.

Retired: Once a version is retired, that version will no longer be accessible via the API.

Non-breaking changes: Non-breaking changes are features which can be added to an active version at any time and will not break your integration. 

Non-breaking changes include:

• New endpoints added 
• New optional query parameters added 
• New optional request fields added to request bodies 
• New optional headers added to the request 
• Mandatory request parameters become optional 
• New fields added to a response 
• New headers added to the response 

Breaking changes: Breaking changes are larger feature updates that can break your existing integration. They include anything not listed above as a non-breaking change. We will only release breaking changes to a new active version of EPS Rapid, so you don’t have to worry about your existing integration.

Basic version

We’ve also created a basic version of Rapid 3 for some unique circumstances. Rapid 3 Basic will have the same features as Rapid 3 at the time of launch, but instead of getting the latest features as soon as they’re available, no new features will be added to this version.

If necessary, a new minor release (e.g. Rapid 3.1 Basic) will be made in order to add any legal or regulatory functionality.

We only recommend this option if you’re an existing EPS partner whose integration has stopped working in the past when it shouldn’t have – this means there may be issues with the way you’ve integrated EPS Rapid.

Example timeline: