API versioning

The Merchant Payments API starts at /v1. The URL version identifies the contract your integration expects.

Version in the base URL

https://api.savapay.io/v1

Compatible changes

SavaPay can improve v1 without changing the meaning of existing fields. Examples include:

• Adding an optional request field.
• Adding a response field existing clients can ignore.
• Adding a new endpoint or event type.
• Improving validation, documentation, or error details without changing the stable code.

Breaking changes

SavaPay does not repurpose a field or change its meaning inside v1. A change that would break an existing integration requires a new API version.

Examples include:

• Removing or renaming a field.
• Changing a field's type or established meaning.
• Making an optional request field required.
• Changing a status or event in a way that invalidates existing handling.

Integration guidance

• Keep the API base URL in configuration instead of repeating it throughout your code.
• Store unknown webhook events safely and ignore them until your code supports them.
• Test API changes in the pilot test environment before production.
• Review the changelog during dependency and release maintenance.