Versioning & Changelog
URL versioning
This API is versioned via its base URL path. Every endpoint in this documentation is served under /v2:
https://production.api.axyscards.com/v2/...
https://staging.api.axyscards.com/v2/...The current API specification is version 1.0.1.
Versioning policy
- Additive, non-breaking changes: new optional request fields, new response fields, new endpoints, or new enum values may be introduced within
/v2without a version-path change. Existing integrations that ignore unrecognized fields will continue to function. - Breaking changes: removing or renaming fields, changing a field's type, or altering existing behavior in a way that could break a working integration will be introduced under a new version path (e.g.
/v3), with the previous version remaining available for a transition period. - Deprecations are announced ahead of removal (see below) and remain functional, with a documented replacement, until they're removed in a future major version.
This page is also where deprecations and notable API changes will be listed going forward. If you're building an integration today, the Deprecations table below is the most important section — it reflects the current state of the
1.0.1specification.
Deprecations
The following endpoints are marked as deprecated in the current specification. They remain functional but new integrations should use the replacement noted:
| Deprecated endpoint | Replacement | Why |
|---|---|---|
POST /cardholders/{cardholderId}/register-wallet-address | None needed — every card automatically receives multi-chain deposit addresses (cryptoAddresses) at issuance | Superseded by automatic, zero-integration straight-through processing (STP). See Funding & Deposits and Fund a Card Automatically via Crypto. |
POST /cards/{cardId}/deposit (blockchain trace notification) | None needed — see above | Same as above |
POST /wallets/{walletId}/deposit (blockchain trace notification) | None needed — see above | Same as above |
These three endpoints represented an older, manual model that required the registration of and notification of a blockchain wallet address. The current model generates deposit addresses automatically and processes incoming digital asset deposits without any notification call from the integrator.
Tracking changes over time
This page documents the current state for the versioning policy and the live deprecations. For a chronological, dated record of API changes (new endpoints, field additions, deprecation announcements, breaking changes), see the Changelog section of this developer hub.
Each Changelog entry is tagged with a type to make scanning easier:
| Type | Used for |
|---|---|
| Added | New endpoints, new optional fields, new enum values |
| Improved | Behavioral improvements that don't change the contract |
| Deprecated | An endpoint or field is marked for future removal, with a replacement noted (see above) |
| Removed | A previously-deprecated endpoint or field has been removed under a new version path |
| Fixed | Corrections to the API or to this documentation (e.g. specification defects) |
You can subscribe to the Changelog feed via RSS to be notified of new entries automatically.
What's next
- Funding & Deposits — for context on the deprecations above
- Errors & Status Codes
- Program Architecture