2025-01-23 Changelog

• Customers API:

  • Customer object - The cards field is retired in Square API version 2025-01-23 and later. This field is replaced by the ListCards and ListGiftCards endpoints with the customer_id query parameter.

    Note that the retirement date for the deprecated CreateCustomerCard and DeleteCustomerCard endpoints isn't currently scheduled, but you should migrate to the Cards API and Gift Cards API as soon as possible. For more information, see Migration notes.

• Reader SDK:

  • Deprecation notice - The Reader SDK is now deprecated and will be retired on December 31, 2025. Developers must migrate to the Mobile Payments SDK to ensure continued support and application functionality.

• Mobile Payments SDK:

  • New React Native plugin for the Mobile Payments SDK.

• Square SDKs:

  • Node.js SDK - The Square Node.js SDK has been rewritten. The new version provides the same access to Square APIs, along with:
    • More runtime compatibility - The SDK supports a wide range of environments, including Node, AWS Lambda, Cloudflare Workers, and more.
    • Auto-pagination - With the SDK, you can easily paginate through long responses.
    • Native fetch - The SDK replaces axios with native fetch. Previous versions of the SDK will continue to work, but to take advantage of these new features and API updates moving forward, you should migrate your code to use the new version of the SDK.

• Web Payments SDK:

  • (Beta) Support for a new payment flow with the Card.tokenize() method for payment processing, buyer verification, and cards on file use cases. For more information, see:
    • Take a Card Payment
    • Store a Card on File
    • Charge a Card on File
    • Charge and Store a Card on File

• Webhooks:

  • The retry schedule for Square webhooks is changed. Square now makes a maximum of 19 retry attempts for up to 48 hours after the event. This change applies to webhook subscriptions for all Square API versions.

• Checkout API:

  • Square Order Checkout - Added a section that explains how to retrieve a customer_id from a payment associated with an order and a checkout.

• Mobile Payments SDK:

  • Handling Errors - Added Swift code samples demonstrating how to unwrap the error messages from Error objects.

• Terminal API:

  • PaymentOptions - API Reference documentation updates for the following parameters:
    • accept_partial_authorization - Updated the description of the default behavior of partial authorization for delayed capture payments.
    • autocomplete - Added a default value of true.
    • delay_duration - Updated the description of delayed capture behavior and the delay duration time for payments.

Learn about versioning for the Square API and SDKs.