Versioning#

When backwards-incompatible changes are made to the API, a new version is released. The current version is 2025-01-15.

Setting the API Version#

You can set the API version on a per-request basis by sending the CasaPay-Version header:

curl https://api.casapay.com/v1/customers \
  -H "Authorization: Bearer sk_test_4eC39HqLyjWDarjtT1zdp7dc" \
  -H "CasaPay-Version: 2025-01-15"

You can also pin the API version for your account in the Dashboard under Developers → API Version. Requests that don't include a version header will use your account's default version.

Backwards-Compatible Changes#

CasaPay considers the following changes to be backwards-compatible:

  • Adding new API resources
  • Adding new optional request parameters
  • Adding new properties to existing API responses
  • Changing the order of properties in existing API responses
  • Adding new event types
  • Adding new values to enums (treat enum lists as open-ended)

Upgrade Guide#

When upgrading your API version:

  1. Review the changelog for breaking changes
  2. Update your integration code to handle new fields and behaviors
  3. Test thoroughly in test mode
  4. Update your account's default version in the Dashboard