Versioning

Whenever Paytron makes a breaking change to our API, a new version will be released. When this occurs we will release an upgrade guide to help you migrate to the latest version. Paytron will continue to support old versions of API's for a yet to be determined amount of time.

Versioning Strategy

Paytron has opted to handle versioning via Content Negotiation and all available versions for a given resource should be listed in the relevant API Reference.

In order to specify an API Version to use, simply attach it to the Accept header in your request

POST / HTTP/1.1
Content-Type: application/vnd.api+json; version=1
Accept: application/vnd.api+json; version=1

Versioning our API's via Content Negotiation allows us to independently version resources and makes our API cache-friendly and helps us adhere to HATEOAS.

🚧

Beware Default Version Behaviour

If you do not specify a version in the Accept header, it will be assumed you want to use the latest version of the API. We therefore recommend you explicitly specify the version in your request headers to avoid breaking integrations as new versions are released.


Did this page help you?