Skip to main content
DocsAPIVersioning

Versioning

Versioning allows clients to continue using the existing API and migrate their applications to the newer version only when they are ready. Such strategy avoids backward incompatibility issue when a new API is being released.

info

We are in the midst of updating all our APIs to support this versioning strategy. Please refer to the respective API product reference to find out currently which API is supporting it.

Backward Compatible Changes​

We consider the following changes to be backward compatible:

  • Adding new API resources, endpoints and assets.
  • Adding new optional parameters to existing API.
  • Adding new properties to existing API responses.
  • Adding new enumeration values.
  • Changing the order of properties in existing API responses.
  • Changing the length or format of opaque strings, such as object IDs, error messages, and other human-readable strings.
  • Adding new event types and codes for webhook.

How to Set Your API Version​

To set the API version, send the calling version in version in the API URL.

Example :

curl --request POST \
  --url https://domain/merchants/{version}/payments/redirect \
  --header 'Authorization: Bearer 123' \
  --header 'Content-Type: application/json' \
  --data '{
}'