API Versioning

When we make backwards-incompatible changes to the WePay API, we release a new dated version. Your app continues to be on the current version of the API to avoid breaking your code.You can follow our Versioning Tutorial to upgrade to the latest API version.

Your app’s WePay API Version determines the behavior that you see from the API. It affects the parameters you can pass in, the response that you get back, and the IPNs you receive.

Version Format

WePay API versions are dates with format yyyy-mm-dd. Ex: 2011-01-15.

API Versions

The current version of the WePay API is 2017-02-01. Full list of API versions can be found here - Change Log

Know your app’s WePay API version

You can check your application’s API version on the configure tab of your application dashboard:

Configure page with API Versioning upgrade button

If you are not on the latest version of the WePay API, follow the link for more information on how to upgrade your application’s API Version: How to Upgrade Version Tutorial.

Backwards-incompatible changes

Following changes are considered to be backwards incompatible changes to the WePay API

  • Removing resources
  • Removing request parameters
  • Adding new required request parameters
  • Removing response parameters in existing API responses
  • Changing the behavior of IPNs
  • Changing permissions for existing resources