Versioning & Updates
UCanPay API adheres to a strict versioning policy to ensure backward compatibility and minimize disruptions to your applications. This page details our approach to API versioning, how you can manage updates, and what changes you can expect in the future.
API Versioning Strategy
Our versioning strategy is designed to provide stability and predictability:
Understanding Our Versioning Strategy
We use semantic versioning (SemVer) for our API. Versions are formatted as `MAJOR.MINOR.PATCH`.
Major releases may introduce breaking changes that could affect existing integrations. They are communicated well in advance.
Minor releases add new features but do not break existing functionality.
Patch releases include bug fixes and minor changes that do not affect the API's external behavior.
Managing API Updates
To ensure a smooth transition between versions, follow these guidelines:
Subscribe to Update Notifications
Stay informed about upcoming releases and changes by subscribing to our API newsletter. You will receive update notifications and detailed release notes.
Testing with Sandbox Environment
Before deploying new versions in your production environment, test them in our sandbox environment to ensure compatibility.
Update Schedule
UCanPay follows a regular update schedule to keep our services secure and efficient:
Major Updates: Scheduled annually, with preliminary release notes provided six months in advance.
Minor Updates: Occur quarterly and include new features and enhancements.
Patch Updates: Deployed as needed, typically monthly, to address urgent issues.
Release Notes
Access the latest and historical release notes to stay informed about the changes and improvements:
Feedback on API Changes
Your feedback is crucial to our continuous improvement. Please let us know how the changes affect your integration and what we can do better:
https://ucanpay.ca/feedback
Contact our support team at support@ucanpay.ca or +1-800-UCANPAY.