Banked uses API versioning to ensure backward compatibility and provide a stable integration experience as our platform evolves. This approach allows us to introduce new features and improvements while maintaining support for existing integrations, giving you time to upgrade at your own pace.
All production endpoints currently use the v2 standard.
Banked's APIs follow established standards that define endpoint structure and versioning.
Example: https://api.banked.com/v2/payments_sessions
v3 standards are currently in development.
Versioning Strategy
Our versioning includes:
- Major versions (v1, v2, v3) introduce significant changes that may include breaking changes
- Backward compatibility is maintained within major versions through non-breaking changes only
- Deprecation notices are provided well in advance of any version retirement
- Multiple versions may be supported simultaneously during transition periods
Change Types
Non-Breaking Changes
No integration updates required
- Endpoints: New endpoints, additional methods
- Fields: New optional request/response fields, required→optional field conversions
- Headers: New optional headers, required→optional header conversions
- Parameters: New optional query parameters, required→optional parameter conversions
- Other: Error message improvements, new HTTP status codes, documentation updates
Integration Guidelines
- Design applications to handle new optional fields and parameters
- Implement robust error handling for new status codes
- Monitor our developer communications for change notifications
- Test integrations against test environment regularly