10 minute read

Versioning

DPS Card and Account Services adds new versions of APIs to include updated and new functionality, or to make changes due to security findings. APIs are versioned when backwards-incompatible changes are introduced.  Backwards-incompatible changes are changes that could cause any existing consumption scenario to fail after the change is released. 

Examples of backwards-incompatible changes include (but are not limited to):

  • Adding a required field in an API request or response
  • Changing business logic that necessitates removing an error description
  • Removing an HTTP response code
  • Removing any element from an API request and response

Examples of backwards-compatible changes include (but are not limited to):

  • Adding an optional response/request field to an API
  • Adding new error descriptions to an API
  • Adding a new HTTP response code to an API

To indicate API versions, DPS Card and Account Services uses a URL element with the version specified in the following format: https://<host>:<port>/<namespace>/v<N>/<resource-path>. 

The version number is an integer, such as 1, 2, 3, etc. You must design and implement for forward compatibility. 

 

Timing

  • DPS Card and Account Services maintains the previous version (N-1) for 12 months in the production environment. You must be fully migrated to the current version before the 12-month period elapses.
  • Older versions will not be supported by Visa and will be removed.  

Communication

DPS Card and Account Services uses the DPS Card and Account Services Bulletin to notify you when new versions are published and provide a timeline to migrate to new versions.