API-Version is used to control which version of the API behavior and contract is applied to a request.By specifying an API-Version in the request header, merchants can continue using a stable API contract without being affected by new features, new parameters, or changes to existing parameters. Any enhancements or breaking changes will only apply to newer API versions.This ensures:
Backward compatibility for existing integrations
Safe rollout of new features and parameter changes
Full control for merchants to upgrade when ready
Merchants who do not update their API-Version will continue to receive the same behavior as their current implementation.
API-Version defines the version of a specific API being used in the request.
Each API (e.g. Checkout API, Payment API) maintains its own versioning lifecycle. Changes such as new parameters, modified parameters, or behavior updates apply only to the specified API and version.