2022-05-12 Changelog

Square Bookings API Checkout API CustomAttributes CustomerCustomAttributes API GiftCards API GraphQL GraphQL Explorer Locations API Payments API Terminal API

Version Summary

• Square Version: 2022-05-12
• Java: 20.0.0.20220512
• .NET: 19.0.0
• Node.js: 19.0.0
• PHP: 19.0.0.20220512
• Python: 19.0.0.20220512
• Ruby: 20.0.0.20220512

Details

Link to section

New API releases

• Customer Custom Attributes API: (beta)

  • The Customer Custom Attributes API enables applications to create and manage custom attributes for customer profiles. For more information, see Custom Attributes for Customer Profiles.

Link to section

API updates

• Bookings API:

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

  • The Bookings API now supports the integration of applications with a seller's paid Square Appointments subscription. For more information, see Integration with paid subscription plans.

• Checkout API:

  • The Checkout API is updated with several new features, including the following new endpoints:

    • CreatePaymentLink

    • UpdatePaymentLink

    • DeletePaymentLink

    • ListPaymentLinks

    • RetrievePaymentLink

    These endpoints are publicly available to all developers as part of an early access program (EAP). You should use the new CreatePaymentLink endpoint in place of the previously released CreateCheckout endpoint.

• Gift Cards API:

  • CreateGiftCard endpoint. This endpoint now supports creating a gift card with a custom GAN. As part of this change, the gan_source field in the GiftCard object is now writable. To specify a custom GAN, include the gan_source and gan fields in the request. For more information, see Custom GANs.

• Locations API:

  • The CreateLocation and UpdateLocation endpoints have moved to the GA state.

• Payments API:

  • The Payments API now supports Cash App payments as a payment source. An application using the Web Payments SDK can take Cash App information from a buyer and generate a payment token. The application can then call CreatePayment to charge the payment token. Cash App payments are supported only in the United States, so only buyers in the United States can choose Cash App as a payment option. For more information, see Cash App Payments.

• Terminal API:

  • The Terminal API now supports additional options for taking payments in a checkout request. These options are in beta and available only in the United States. For more information, see Additional options for payments in a checkout.

  • The Terminal API has new endpoints in beta called Terminal actions, which are available in the United States, Canada, and Australia. The Terminal API includes the following new endpoints:

    • CreateTerminalAction

    • SearchTerminalActions

    • GetTerminalAction

    • CancelTerminalAction

    These new endpoints are used for saving cards on file with the Terminal API. For more information, see Save a card on file with the Terminal API.
    
    

  • New webhooks for Terminal actions:

    • terminal.action.created

    • terminal.action.updated

  • New test IDs for Terminal actions. For a list of these new test IDs, see Terminal API (actions).

Link to section

Documentation updates

• Custom attributes:

  • Custom Attributes Overview. Added this topic about using custom attributes (beta).

• GraphQL:

  • GraphQL Overview. Added this topic about using GraphQL (alpha) with Square APIs.

  • GraphQL Explorer. Added this topic that describes how to use GraphQL Explorer (alpha) with Square APIs.