All Versions
Latest Version
Avg Release Cycle
19 days
Latest Release
1217 days ago

Changelog History
Page 1

  • v3.20200528.1 Changes

    May 28, 2020

    Square SDK - PHP

    ๐Ÿš€ Square is excited to announce the public release of customized SDK for PHP

    To align with other Square SDKs generated for SQUARE API version 2020-05-28, the initial version of this PHP SDK is

  • v3.20200528.0 Changes

    May 28, 2020

    ๐Ÿš€ API releases

    โšก๏ธ Existing API updates

    Orders API

    • CalculateOrder (beta) endpoint. Use the endpoint to calculate adjustments (for example, taxes and discounts) to an order for preview purposes. In response, the endpoint returns the order showing the calculated totals. You can use this endpoint with an existing order or an order that has not been created.
      โšก๏ธ The endpoint does not update an existing order. It only returns a calculated view of the order that you provided in the request. To create or update an order, use the CreateOrder and UpdateOrder endpoints, respectively.
    • Order type. Two fields are added in support of the Loyalty API integration. For more information, see Deferred reward creation. For an example, see Redeem Points.
      • Order.rewards represents rewards added to an order by calling the CreateLoyaltyReward endpoint.

      - indicates that a discount is the result of the specified rewards that were added to an order using the CreateLoyaltyReward endpoint.

    Customers API

    • The Search Customers endpoint supports search by email address, phone number, and reference ID with the following additional query filters:
    • The created_at, updated_at, and id attributes on the Customer resource are updated to be optional. As a result, they no longer are required input parameters when you call the Square SDKs to create a Customer object. You might need to update the dependent SDKs to the latest version to mediate breaking your existing code.

    Square Webhooks

  • v3.20200422.2 Changes

    April 25, 2020

    โšก๏ธ Existing API updates

    • OAuth API
      • Obtain Token endpoint: Removed the scopes property from the request body.
  • v3.20200422.1 Changes

    April 22, 2020

    ๐Ÿš€ API releases

    • Customer Segments API (beta). limit field removed from ListCustomerSegments endpoint.

    Note: This release fixes a bug introduced on the April 22, 2020 release of the Square API.

  • v3.20200422.0 Changes

    April 22, 2020

    ๐Ÿš€ API releases

    Terminal API. The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments.

    - For technical reference, see Terminal API.

    Devices API. The new Devices API lets a custom third-party POS app generate a code used to sign in to a Square Terminal to create a pairing that lets the POS app send terminal checkout requests. For technical reference, see Devices API.

    Customer Groups API (beta). The new Customer Groups API (Beta) enables full CRUD management of customer groups, including the ability to list, retrieve, create, update, and delete customer groups. Previously, this functionality was only available through the Square dashboard and point-of-sale product interfaces.

    - For technical reference, see Customer Groups.

    Customer Segments API (beta). The new Customer Segments API (Beta) lets you list and retrieve customer segment (also called smart groups) information. Coupled with the new segment_ids field on the customer resource, this API lets you better understand and track the customer segments to which a customer belongs.

    - For technical reference, see Customer Segments.

    ๐Ÿ†• New webhooks. v2 Webhooks (beta) now supports webhooks for the following APIs:

    • Orders API. order.created, order.updated, and order.fulfillment.updated
    • Terminal API. terminal.checkout.created and terminal.checkout.updated
    • Devices API. device.code.paired

    ๐Ÿ‘€ For more information, see Subscribe to Events.

    โšก๏ธ Existing API updates

    Customers API

    • AddGroupToCustomer endpoint. Added to add customer memberships to a customer group.
    • RemoveGroupFromCustomer endpoint. Added to remove customer memberships from a customer group.
    • Customer object. Updated as follows:
      • group_ids field. Added to designate groups the customer is in.
      • segment_ids field. Added to designate segments the customer is in.
      • groups field. Deprecated to be replaced by group_ids and segment_ids. It remains supported for one year from this release.
    • CustomerQuery object's filter parameter. Updated as follows:

      - group_ids filter. Added to search for customers based on whether they belong to any, all, or none of the specified groups.

    Orders API

    • OrderFulfillmentPickupDetails type updated to support curbside pickup:
      • is_curbside_pickup. This Boolean field indicates curbside pickup.

      - CurbsidePickupDetails. This type provides supporting information for curbside pickup, including a buyer description (for example, "buyer is in a red car") and a timestamp when the buyer arrived for the pickup.

    OAuth API

    - ObtainToken endpoint. Added a new field called scopes. This field lets a client change the set of permissions for an access token when making a request to refresh the token.

    Catalog API

    - ENUMCatalogItemProductType. The ENUM value GIFT_CARD is now deprecated.

    Payments API. See Take Payments and Collect Fees for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.

  • v3.20200325.0 Changes

    March 25, 2020

    โšก๏ธ Existing API updates

    • Payments API. In support of the existing Delayed capture for payments, the following fields are added to the Payment type:
      • delay_duration. In a CreatePayment request, you can set autocomplete to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see Delay capture.
      • delay_action. Defines the action that Square takes on the payment when the delay_duration elapses. In this release, the API supports only the cancel payment action.
      • delayed_until. Provides the date and time on Square servers when Square applies delay_action on the payment.
  • v3.20200226.0 Changes

    February 26, 2020

    ๐Ÿš€ API releases

    ๐Ÿš€ GA release : All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs.

    ๐Ÿš€ Beta release : All SDKs have been updated to support the new Disputes API.

  • v2.20200122.2 Changes

    February 12, 2020

    Documentation Changes

    • โšก๏ธ Minor updates for Payments API descriptions
    • ๐Ÿ—„ Deprecation & retirement dates added for Transactions API endpoints
  • v2.20200122.1 Changes

    February 04, 2020

    ๐Ÿ“š Documentation Changes

    • โšก๏ธ Minor updates for Payments API descriptions
    • ๐Ÿ—„ Deprecation & retirement dates added for Transactions API endpoints
  • v2.20200122.0 Changes

    January 22, 2020
    • New field: The Employee object now has an is_owner field.
    • New field: The Card enumeration has a new SQUARE_CAPITAL_CARD enum value to support a Square one-time Installments payment.

    • New request body field constraint: The Refund Payment request now required a non-empty string when the payment_id is supplied.