2025-03-19 Changelog

• Cards API:

  • Card object - New read-only Beta fields to help developers manage card declines more effectively:

    • hsa_fsa - Indicates whether the card is linked to a Health Savings Account (HSA) or a Flexible Spending Account (FSA), which tend to have higher decline rates.
    • issuer_alert - An alert from the issuing bank about the card status. For select Mastercard payment cards, this field is set to ISSUER_ALERT_CARD_CLOSED if Square is notified that the underlying account is closed.
    • issuer_alert_at - The timestamp of when the alert was last received and processed.

    For more information, see Manage Card-on-File Declines.

  • CreateCard endpoint - The postal_code field in the billing address can now be specified in ZIP+4 format (for example, 12345-6789).

• Invoices API:

  • Invoice object - New read-only creator_team_member_id field that contains the ID of the team member who created the invoice. This field is present only on invoices created in the Square Dashboard or Square Invoices application by a logged-in team member.

  • CreateInvoiceAttachment endpoint - In the Sandbox environment, invoices now have a total file size limit of 1 KB for all attachments. This change doesn't apply to invoices in production, where the total file size limit for all attachments is 25 MB.

    These changes apply to all Square API versions.

• Square SDKs:

  • The Square Java SDK and .NET SDK have been rewritten. The new versions provide the same access to Square APIs, along with:

    • Auto-pagination - With the new SDKs, you can easily paginate through long responses.
    • Simplified classes and method names.

    Previous versions of the SDKs continue to work, but to take advantage of these new features and API updates moving forward, you should migrate your Java integration and migrate your .NET integration to use the new version of the SDKs.

• Terminal API:

  • General Availability - Support for localized receipts for orders, itemization, and ID for Japan and the EU. For more information, see Take Payments for Orders.

• Checkout API:

  • Subscription Plan Checkout - Rewrote content with updated examples. Customers subscribe to a subscription plan variation, not to a subscription plan. For this reason, the subscription_plan_id value in the CreatePaymentLink request must contain the ID value for a subscription plan variation.

• In-App Payments SDK:

  • Removed SRC Masterpass guide topics and API Reference for iOS and Android, due to SRC deprecation that took place in May 2023.

Learn about versioning for the Square API and SDKs.