Skip to main content

API Versioning

A55 uses URL-based versioning with a stable backwards-compatibility contract. The current version is v1 and all endpoints are served under:

https://core-manager.a55.tech/api/v1/

Versioning strategy

AspectPolicy
SchemeURL path prefix (/api/v1/, /api/v2/)
Current versionv1
StabilityProduction-stable — no breaking changes within a major version
Deprecation noticeMinimum 6 months before a major version is sunset
Sunset period12 months of dual-version support during migration

What counts as a breaking change

These changes trigger a new major version:

Breaking changeExample
Removing a field from a responseDropping usd_currency from charge response
Renaming a required request fieldpayer_namecardholder_name
Changing a field's typeinstallment_count from integer to string
Removing an endpointDropping POST /charge/
Changing authentication schemeBearer token → API key
Changing error response structuremessage: stringmessage: array

What is NOT a breaking change

These changes happen within the current version without notice:

Non-breaking changeExample
Adding new optional request fieldsNew metadata field on create charge
Adding new fields to responsesNew provider_reference in charge response
Adding new endpointsPOST /api/v1/bank/wallet/checkout/
Adding new enum valuesNew type_charge: "googlepay"
Adding new HTTP status codesNew 429 rate limit response
Improving error descriptionsMore specific error messages
Performance improvementsFaster response times
Always handle unknown fields

Your integration should ignore unknown fields in API responses. A55 may add new response fields at any time as a non-breaking change. Use permissive JSON parsing and avoid strict schema validation on responses.


Environment URLs

EnvironmentBase URLPurpose
Productionhttps://core-manager.a55.tech/api/v1Live transactions
Sandboxhttps://sandbox.api.a55.tech/api/v1Testing and development

Use environment variables to switch between environments:

export A55_API_URL="https://sandbox.api.a55.tech"   # Development
export A55_API_URL="https://core-manager.a55.tech" # Production
export A55_ACCESS_TOKEN="your-token-here"

Deprecation process

When a new major version is released:

  1. Announcement — Blog post, email notification, and dashboard banner 6+ months before sunset.
  2. Dual support — Both versions run in parallel for 12 months. v1 endpoints return a Deprecation header.
  3. Migration guide — A detailed field-by-field migration guide is published.
  4. Sunset — After the sunset date, old version returns 410 Gone with a migration link.

Deprecation headers

When a version or endpoint is deprecated, responses include:

Deprecation: true
Sunset: Sat, 01 Mar 2027 00:00:00 GMT
Link: <https://docs.a55.tech/migration/v1-to-v2>; rel="successor-version"

SDK versioning

A55 SDKs follow semantic versioning:

SDKPackageVersioning
JavaScript@a55/a55pay-sdkMAJOR.MINOR.PATCH
Pythona55-sdkMAJOR.MINOR.PATCH

SDK major versions align with API major versions. A new API v2 will ship with SDK 2.x.