Square 2024-04-17 — Breaking Changes Checklist

4 items total2 critical~1 hour for a typical integration

Before You Upgrade

1.Review the official Square API v2024-04-17 release notes for a comprehensive list of all changes.
2.Identify all endpoints and object types your integration interacts with that are affected by the changes outlined in this checklist.
3.Backup your current application code and database.
4.Set up a separate testing environment that mirrors your production setup.

0/2

Review changes to the Catalog API, as these modifications can impact how you manage your catalog and related data.

Update code to no longer use deprecated Catalog object types.Criticalmedium

Certain Catalog object types have been deprecated and will be removed. Ensure your integration does not rely on these types.

⚠ Catalog data may become inaccessible or unmanageable.

Remove references to the `caption` field in Catalog image objects.Higheasy

The `caption` field within Catalog image objects has been removed. Any code attempting to access or set this field will fail.

⚠ Image caption data will be lost and API calls related to image captions will error.

0/2

Understand the updates to the Payment API to ensure your payment processing remains uninterrupted.

Verify idempotency key format for Payment API requests.Mediumeasy

Ensure your idempotency keys adhere to the specified format to prevent unexpected payment processing issues.

⚠ Duplicate payment requests may be processed, leading to incorrect financial reporting.

Adapt code to handle updated payment status enumerations.Criticalmedium

The possible values for payment statuses have been updated. Your application logic should account for these changes.

⚠ Payment status handling may fail, leading to incorrect order fulfillment or customer service issues.

✓Perform comprehensive regression testing in your testing environment, covering all critical user flows.
✓Monitor your application logs for any new errors or warnings related to the Square API.
✓Verify that all payment transactions are processed correctly and that catalog data is accurately retrieved and updated.
✓Gradually roll out the updated API version to a small subset of users in production while monitoring closely.
✓Confirm that all reports and financial data generated by your integration are accurate.

Deprecatr AI monitors 150+ providers, maps changes to your codebase, and delivers migration checklists before your team hits a breaking change.