2021-05-13 Changelog

Square Sites API Snippets API Loyalty API Payments API Connect v1

Version Summary

• Square Version: 2021-05-13
• Java: 11.0.0.20210513
• .NET: 11.0.0
• Node.js: 11.0.0
• PHP: 11.0.0.20210513
• Python: 11.0.0.20210513
• Ruby: 11.0.0.20210513

Details

Link to section

New API releases

• Sites API. The Sites API lets you retrieve basic details about the Square Online sites that belong to a Square seller. For more information, see Sites API Overview.

• Snippets API. The Snippets API lets you manage snippets that provide custom functionality on Square Online sites. A snippet is a script that is injected into all pages on a site, except for checkout pages. For more information, see Snippets API Overview.

Link to section

API updates

• Payments API:

  • CreatePayment. The CreatePayment endpoint now supports ACH Bank Transfer payments. For more information, see ACH Bank Transfer Payment.

• Loyalty API:

  • The Loyalty API has moved to the general availability (GA) state.

  • The ListLoyaltyPrograms endpoint is deprecated. It is replaced by calling the RetrieveLoyaltyProgram endpoint with the main keyword.

  • LoyaltyAccount object. The mappings field is retired and replaced by the mapping field.

  • LoyaltyAccountMapping object. The type and value fields are retired and replaced by the phone_number field.

  For more information, see Migration notes.

• V1 APIs deprecated. V1 Payments and V1 Settlements APIs are now deprecated. For information about these APIs, see Deprecated.

Link to section

Documentation updates

• Getting Started. Added a step that shows how to use the API Logs to examine a transaction. For more information, see Step 4: View the transaction in the API Logs (beta).

• All Orders API content in the Technical Reference is now edited for grammar and consistency.