Square API Version

Setting and changing the API version for Square

This content applies to Square Webpay only.

Please note the specific versions below are examples only - the current version may use different dates. Be sure to get the correct API version for your copy of Square WebPayments.

For versions 3.x and above, the Square API version is set in the file includes/modules/payment/square_webPay/square/square/src/Legacy/ConfigurationDefaults.php

It looks like this:

    public const SQUARE_VERSION = '2025-01-23';

For versions 2.x and below, the Square API version is set in the file includes/modules/payment/square_webPay/square/square/src/ConfigurationDefaults.php

It looks like this:

    public const SQUARE_VERSION = '2024-01-18';

Be sure to specify the correct version on the Credentials page for your App when you first install Square Webpay, and every time you update the Square Webpay software. To change the version for your site, go to https://connect.squareup.com/apps, select your app, then click “App details” on the left sidebar.

Square App Details

Click the “Change version” link on the “Production API version” line.

Square API Version

Set it to the version in the file shown above.

You may use different API Versions for your live and test sites by creating both a live and a test app, and setting the versions on each independently. This can be convenient in situations like testing an upgrade.




Still have questions? Use the Search box in the upper right, or try the full list of FAQs. If you can't find it there, head over to the Zen Cart support forum and ask there in the appropriate subforum. In your post, please include your Zen Cart and PHP versions, and a link to your site.

Is there an error or omission on this page? Please post to General Questions on the support forum. Or, if you'd like to open a pull request, just review the guidelines and get started. You can even PR right here.
Last modified August 2, 2025 by Scott Wilson (6bdab58).