API Versioning

All Exirom API endpoints use URL path versioning with the v1 prefix.

#Base URL

https://api.exirom.com/api/api/v1/

#Current Version

All endpoints documented on this site are part of the v1 API.

#Stability Policy

The v1 API is stable. We will not introduce breaking changes to existing endpoints. Non-breaking additions (new optional fields, new endpoints) may be added without a version bump.

#What counts as a breaking change

• Removing or renaming an existing field
• Changing the type of an existing field
• Removing an endpoint
• Changing required/optional status of a request field
• Changing the meaning of a status code

#What is NOT a breaking change

• Adding a new optional field to a request or response
• Adding a new endpoint
• Adding a new enum value
• Adding a new webhook event type

#Recommendations

• Always include the version prefix (/api/v1/) in your integration
• Do not hardcode the base URL — use a configurable variable
• Parse responses tolerantly — ignore unknown fields rather than failing

Additive changes: New fields may appear in responses at any time. Your integration should ignore unknown fields rather than failing on them.

Unknown enum values: New enum values (e.g., new transaction statuses, new decline codes) may be added without a version bump. Your integration should handle unknown enum values gracefully -- log and ignore them rather than throwing an error.

#See Also

• Getting Started -- environment setup and integration paths
• Going to Production -- production readiness checklist