# v2025-06-01

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

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

- **Production**: `sk_prod_...`
- **Test**: `sk_test_...`

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

The old `PSK_....` format will no longer be supported.
Refer to [Authentication](https://docs.superpayments.com/reference/intro-authentication).

## Payment Initiator Required  
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
- [Initiate Payment Transaction](https://docs.superpayments.com/reference/initiate-payment-transaction-1)
- [Create a new checkout session](https://docs.superpayments.com/reference/create-checkout-session)
- [Proceed with payment via checkout session](https://docs.superpayments.com/reference/proceed-payment-via-checkout-session).

# v2024-10-01

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

**Relevant endpoints:**
- [Generate Reward Calculation](https://docs.superpayments.com/reference/generate-reward-calculation)
- [Initiate Payment Transaction](https://docs.superpayments.com/reference/initiate-payment-transaction-1)
- [Initiate Refund Transaction](https://docs.superpayments.com/reference/initiate-refund-transaction-1)

# v2024-02-01

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

## Authentication  
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.

## Rewards Calculations  
The `/v2/offers` resource has been replaced with `/2024-02-01/reward-calculations`.
Refer to [Generate Reward Calculation](https://docs.superpayments.com/reference/generate-reward-calculation).

## Errors  
The error response formats for all endpoints differ significantly from v2.
The error formats now adhere to standard [RFC 9457](https://www.rfc-editor.org/rfc/rfc9457.html) prescribed formats.
Refer to [Errors](https://docs.superpayments.com/reference/errors).

## Rate Limiting  
A rate limit has been introduced and now applies to all endpoints. Refer to [Rate Limiting](https://docs.superpayments.com/reference/rate-limiting).

## Specifying monetary amounts  
The v2 API utilized `minorUnitAmount` when referring 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:**
- [Generate Reward Calculation](https://docs.superpayments.com/reference/generate-reward-calculation)
- [Initiate Payment Transaction](https://docs.superpayments.com/reference/initiate-payment-transaction-1)
- [Initiate Refund Transaction](https://docs.superpayments.com/reference/initiate-refund-transaction-1).

## Specifying brand  
A brand-ID must be specified when interacting with the API.
To retrieve the correct brand ID, visit the [Developers, API keys](https://business.superpayments.com/dashboard/developers/api-keys) section on the business portal.

Viewing brand ID's

Updated 2 months ago.