Changelog

The Atlas Commerce API uses date-based versioning. Pin your integration to a specific version by sending the Atlas-API-Version header. Versions are additive by default — existing fields and behaviors never change inside a pinned version. Breaking changes always ship as a new dated version with a deprecation notice on the previous one.

curl $BASE_URL/v1/transaction/sale \
  -H "X-Api-Key: $ATLAS_API_KEY" \
  -H "Atlas-API-Version: 2026-04-09" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "type": "SALE", "amount": 2500, "currency": "NZD" }'

Versioning policy

• Your integration is pinned forever. Once you send an Atlas-API-Version header, we guarantee that version's behavior for the lifetime of your merchant account.
• Omitting the header defaults to your merchant's account version. Set once in the dashboard — useful for simple integrations that want the latest behavior without code changes.
• Deprecations get 12 months of notice. Deprecated endpoints return a Sunset header alongside their normal response until the version is retired.
• Only additive changes ship within a version. New response fields, new optional request fields, new enum values — these never warrant a new version.

Releases