Menu

Versioning

Our API will be versioned with "v1", "v2" etc. in the URL path. We will ensure that our API is as much as possible backwards compatible, but if we have to break backwards compatibility, we will increment the API version and make sure that we will continue to support the old version until you are ready to upgrade so we will never break your code.

Important: there are some types of changes that we consider "backwards compatible". We may make these types of changes from time-to-time so you need to make sure that your code does not break if we do this:

  • Adding new API resources
  • Adding a new optional parameters or changing the order of parameters of existing resources, both for requests and responses
  • Adding new "paymentStatus" values to both Order responses and the webhook
  • Changing the length of the Worldpay generated fields of existing resources. Example include the "id" field and "orderCode" of the Order resource
  • Changing the descriptions in the "reason" field of Order responses

Code library versioning

The code libraries will follow the API version as major, with minor and patch extensions. For example the Library 1.0.0 will be compatible with API 'v1', Library version 1.2.1 will also be compatible with API 'v1' and may contain new features and bug fixes. We will ensure that new minor versions of the libraries will be backwards compatible.

Important: there are some types of changes that we consider "backwards compatible". We may make these types of changes from time-to-time so you need to make sure that your code does not break if we do this:

  • Adding new functions
  • Adding new optional parameters both for input and output