v2025-06-01

Version

The version specified in the API-path should be versioned /2025-06-01.

The API key format has been updated. New API keys now use the following prefixes:

Please generate these from the portal in order to use version 2025-06-01

The old PSK_.... format will no longer be supported

Both payment and checkout resources now require a paymentInitiatorId parameter:

Payments: The paymentInitiatorId field is now mandatory when creating payments
Checkout: The paymentInitiatorId field is now mandatory for both creation and proceed requests

Refer to

The version specified in the API-path should versioned /2024-10-01. This has changed from the previous version /2024-02-01.

Relevant endpoints:

The version specified in the API-path should be the date versioned /2024-02-01. This has changed from the previous numeric version /v2.

The checkout-api-key header that was used for authentication is no longer supported.

Please populate the standard Authorization header instead with your API key.

The /v2/offers resource has been replaced with /2024-02-01/reward-calculations.

The error response formats for all endpoints differ significantly from v2.
The error formats now adhere to standard RFC 9457 prescribed formats.

Refer to Errors.

A rate limit has been introduced and now applies to all endpoints. Refer to Rate Limiting.

The v2 API utilised minorUnitAmount when refering to amounts. This has been replaced with simply amount.

The values specified in amount properties should continue to be specified in minor currency units (e.g. pence for GBP).

Relevant endpoints:

A brand-ID must be specified when interacting with the API.

To retrieve the correct brand ID, visit the Developers, API keys section on the business portal.