API Versioning
How Chargeflow's date-based path versioning works, the deprecation policy, and the table of available API versions.
Chargeflow uses date-based, path parameter versioning for its public API. This approach gives you a stable, predictable URL structure and ample time to migrate whenever breaking changes are introduced.
Using API versions
Select the API version by including the version date in the request path:
https://api.chargeflow.io/public/{apiVersion}/...Replace {apiVersion} with the version string from the Available versions table below. For example:
https://api.chargeflow.io/public/2025-04-01/disputesAlways include an explicit version in your requests. This ensures your integration is unaffected by future changes to newer versions.
Deprecation policy
During significant updates, Chargeflow may mark specific API methods of a version as deprecated. When a method is marked as deprecated, it indicates that it will no longer be available in upcoming versions. Deprecation notices are communicated in advance, giving you time to migrate before the method is removed.
Available versions
| Version | Release date | Notes |
|---|---|---|
2024-03-18 | March 18, 2024 | Initial API release |
2025-04-01 | April 1, 2025 | New endpoints and payload modifications |
Note
Use the version string exactly as shown (e.g., 2025-04-01) in the URL path. Do not use shortened or alternate date formats.