Skip to main content

API Versioning

Learn how the Paytient Partner API handles versioning and backward compatibility.

Overview​

The Paytient Partner API uses dated versions to ensure backward compatibility when introducing breaking changes.

Current Version​

2024-01-16

All API requests must include this version in the api-version header:

api-version: 2024-01-16

Version Format​

Versions use the ISO 8601 date format: YYYY-MM-DD

This date represents when the API version was released, not when you started using it.

How Versioning Works​

Non-Breaking Changes​

We make non-breaking changes to the current API version without requiring a version bump:

  • Adding new endpoints
  • Adding optional request parameters
  • Adding new properties to responses
  • Adding new enum values

Breaking Changes​

When we make breaking changes, we release a new dated version:

  • Removing endpoints
  • Removing request/response fields
  • Changing field types
  • Changing authentication requirements
  • Modifying error responses

Version Lifecycle​

  1. Release - New version announced in changelog
  2. Active Support - We maintain and support the version
  3. Deprecation Notice - 6 months warning before deprecation
  4. Deprecated - Version still works but unsupported
  5. Sunset - Version no longer accessible (12+ months after deprecation)

Available Versions​

2024-01-16 (Latest)​

Released: January 16, 2024

New Features:

  • New CIP status: NEEDS_EXPANDED_VERIFICATION
  • Integration endpoint for testing expanded verification
  • Enhanced employee endpoint for verification flow

2021-08-10​

Released: August 10, 2021

Features:

  • Initial Partner API release
  • Employer and employee management
  • Transaction tracking
  • Card issuance

Next Steps​